Compute Engine API
Creates and runs virtual machines on Google Cloud Platform.
- Version:
- alpha
Example
var google = require('googleapis');
var compute = google.compute('alpha');
Methods
-
staticcompute(alpha).compute.addresses.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 61 -
Retrieves an aggregated list of addresses.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.addresses.delete(params, callback){object}
apis/compute/alpha.js, line 91 -
Deletes the specified address resource.
Name Type Description paramsobject Parameters for request
Name Type Description addressstring Name of the address resource to delete.
projectstring Project ID for this request.
regionstring Name of the region for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.addresses.get(params, callback){object}
apis/compute/alpha.js, line 121 -
Returns the specified address resource.
Name Type Description paramsobject Parameters for request
Name Type Description addressstring Name of the address resource to return.
projectstring Project ID for this request.
regionstring Name of the region for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.addresses.insert(params, callback){object}
apis/compute/alpha.js, line 151 -
Creates an address resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
resourcecompute(alpha).Address Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.addresses.list(params, callback){object}
apis/compute/alpha.js, line 184 -
Retrieves a list of addresses contained within the specified region.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring Name of the region for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.addresses.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 215 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The name of the region for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.autoscalers.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 251 -
Retrieves an aggregated list of autoscalers.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.autoscalers.delete(params, callback){object}
apis/compute/alpha.js, line 281 -
Deletes the specified autoscaler.
Name Type Description paramsobject Parameters for request
Name Type Description autoscalerstring Name of the autoscaler to delete.
projectstring Project ID for this request.
zonestring Name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.autoscalers.get(params, callback){object}
apis/compute/alpha.js, line 311 -
Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description autoscalerstring Name of the autoscaler to return.
projectstring Project ID for this request.
zonestring Name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.autoscalers.insert(params, callback){object}
apis/compute/alpha.js, line 341 -
Creates an autoscaler in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
zonestring Name of the zone for this request.
resourcecompute(alpha).Autoscaler Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.autoscalers.list(params, callback){object}
apis/compute/alpha.js, line 374 -
Retrieves a list of autoscalers contained within the specified zone.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
zonestring Name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.autoscalers.patch(params, callback){object}
apis/compute/alpha.js, line 405 -
Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.
Name Type Description paramsobject Parameters for request
Name Type Description autoscalerstring Name of the autoscaler to update.
projectstring Project ID for this request.
zonestring Name of the zone for this request.
resourcecompute(alpha).Autoscaler Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.autoscalers.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 436 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.autoscalers.update(params, callback){object}
apis/compute/alpha.js, line 467 -
Updates an autoscaler in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description autoscalerstring optional Name of the autoscaler to update.
projectstring Project ID for this request.
zonestring Name of the zone for this request.
resourcecompute(alpha).Autoscaler Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendBuckets.delete(params, callback){object}
apis/compute/alpha.js, line 500 -
Deletes the specified BackendBucket resource.
Name Type Description paramsobject Parameters for request
Name Type Description backendBucketstring Name of the BackendBucket resource to delete.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendBuckets.get(params, callback){object}
apis/compute/alpha.js, line 529 -
Returns the specified BackendBucket resource. Get a list of available backend buckets by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description backendBucketstring Name of the BackendBucket resource to return.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendBuckets.getIamPolicy(params, callback){object}
apis/compute/alpha.js, line 558 -
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendBuckets.insert(params, callback){object}
apis/compute/alpha.js, line 587 -
Creates a BackendBucket resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).BackendBucket Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendBuckets.list(params, callback){object}
apis/compute/alpha.js, line 619 -
Retrieves the list of BackendBucket resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendBuckets.patch(params, callback){object}
apis/compute/alpha.js, line 649 -
Update the entire content of the BackendBucket resource. This method supports patch semantics.
Name Type Description paramsobject Parameters for request
Name Type Description backendBucketstring Name of the BackendBucket resource to update.
projectstring Project ID for this request.
resourcecompute(alpha).BackendBucket Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendBuckets.setIamPolicy(params, callback){object}
apis/compute/alpha.js, line 679 -
Sets the access control policy on the specified resource. Replaces any existing policy.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).Policy Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendBuckets.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 709 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendBuckets.update(params, callback){object}
apis/compute/alpha.js, line 739 -
Update the entire content of the BackendBucket resource.
Name Type Description paramsobject Parameters for request
Name Type Description backendBucketstring Name of the BackendBucket resource to update.
projectstring Project ID for this request.
resourcecompute(alpha).BackendBucket Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendServices.delete(params, callback){object}
apis/compute/alpha.js, line 772 -
Deletes the specified BackendService resource.
Name Type Description paramsobject Parameters for request
Name Type Description backendServicestring Name of the BackendService resource to delete.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendServices.get(params, callback){object}
apis/compute/alpha.js, line 801 -
Returns the specified BackendService resource. Get a list of available backend services by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description backendServicestring Name of the BackendService resource to return.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendServices.getHealth(params, callback){object}
apis/compute/alpha.js, line 831 -
Gets the most recent health check results for this BackendService.
Name Type Description paramsobject Parameters for request
Name Type Description backendServicestring Name of the BackendService resource to which the queried instance belongs.
projectstring resourcecompute(alpha).ResourceGroupReference Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendServices.insert(params, callback){object}
apis/compute/alpha.js, line 860 -
Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).BackendService Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendServices.list(params, callback){object}
apis/compute/alpha.js, line 892 -
Retrieves the list of BackendService resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendServices.patch(params, callback){object}
apis/compute/alpha.js, line 922 -
Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.
Name Type Description paramsobject Parameters for request
Name Type Description backendServicestring Name of the BackendService resource to update.
projectstring Project ID for this request.
resourcecompute(alpha).BackendService Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendServices.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 952 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.backendServices.update(params, callback){object}
apis/compute/alpha.js, line 982 -
Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.
Name Type Description paramsobject Parameters for request
Name Type Description backendServicestring Name of the BackendService resource to update.
projectstring Project ID for this request.
resourcecompute(alpha).BackendService Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.clientSslPolicies.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 1016 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.disks.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 1151 -
Retrieves an aggregated list of persistent disks.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.disks.createSnapshot(params, callback){object}
apis/compute/alpha.js, line 1183 -
Creates a snapshot of a specified persistent disk.
Name Type Description paramsobject Parameters for request
Name Type Description diskstring Name of the persistent disk to snapshot.
guestFlushboolean optional projectstring Project ID for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).Snapshot Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.disks.delete(params, callback){object}
apis/compute/alpha.js, line 1213 -
Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.
Name Type Description paramsobject Parameters for request
Name Type Description diskstring Name of the persistent disk to delete.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.disks.get(params, callback){object}
apis/compute/alpha.js, line 1243 -
Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description diskstring Name of the persistent disk to return.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.disks.insert(params, callback){object}
apis/compute/alpha.js, line 1274 -
Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
sourceImagestring optional Optional. Source image to restore onto a disk.
zonestring The name of the zone for this request.
resourcecompute(alpha).Disk Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.disks.list(params, callback){object}
apis/compute/alpha.js, line 1307 -
Retrieves a list of persistent disks contained within the specified zone.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.disks.resize(params, callback){object}
apis/compute/alpha.js, line 1338 -
Resizes the specified persistent disk.
Name Type Description paramsobject Parameters for request
Name Type Description diskstring The name of the persistent disk.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).DisksResizeRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.disks.setLabels(params, callback){object}
apis/compute/alpha.js, line 1369 -
Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).ZoneSetLabelsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.disks.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 1400 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.diskTypes.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 1052 -
Retrieves an aggregated list of disk types.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.diskTypes.get(params, callback){object}
apis/compute/alpha.js, line 1082 -
Returns the specified disk type. Get a list of available disk types by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description diskTypestring Name of the disk type to return.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.diskTypes.list(params, callback){object}
apis/compute/alpha.js, line 1115 -
Retrieves a list of disk types available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.firewalls.delete(params, callback){object}
apis/compute/alpha.js, line 1433 -
Deletes the specified firewall.
Name Type Description paramsobject Parameters for request
Name Type Description firewallstring Name of the firewall rule to delete.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.firewalls.get(params, callback){object}
apis/compute/alpha.js, line 1462 -
Returns the specified firewall.
Name Type Description paramsobject Parameters for request
Name Type Description firewallstring Name of the firewall rule to return.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.firewalls.insert(params, callback){object}
apis/compute/alpha.js, line 1491 -
Creates a firewall rule in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).Firewall Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.firewalls.list(params, callback){object}
apis/compute/alpha.js, line 1523 -
Retrieves the list of firewall rules available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.firewalls.patch(params, callback){object}
apis/compute/alpha.js, line 1553 -
Updates the specified firewall rule with the data included in the request. This method supports patch semantics.
Name Type Description paramsobject Parameters for request
Name Type Description firewallstring Name of the firewall rule to update.
projectstring Project ID for this request.
resourcecompute(alpha).Firewall Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.firewalls.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 1583 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.firewalls.update(params, callback){object}
apis/compute/alpha.js, line 1613 -
Updates the specified firewall rule with the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description firewallstring Name of the firewall rule to update.
projectstring Project ID for this request.
resourcecompute(alpha).Firewall Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.forwardingRules.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 1649 -
Retrieves an aggregated list of forwarding rules.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.forwardingRules.delete(params, callback){object}
apis/compute/alpha.js, line 1679 -
Deletes the specified ForwardingRule resource.
Name Type Description paramsobject Parameters for request
Name Type Description forwardingRulestring Name of the ForwardingRule resource to delete.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.forwardingRules.get(params, callback){object}
apis/compute/alpha.js, line 1709 -
Returns the specified ForwardingRule resource.
Name Type Description paramsobject Parameters for request
Name Type Description forwardingRulestring Name of the ForwardingRule resource to return.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.forwardingRules.insert(params, callback){object}
apis/compute/alpha.js, line 1739 -
Creates a ForwardingRule resource in the specified project and region using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).ForwardingRule Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.forwardingRules.list(params, callback){object}
apis/compute/alpha.js, line 1772 -
Retrieves a list of ForwardingRule resources available to the specified project and region.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.forwardingRules.setTarget(params, callback){object}
apis/compute/alpha.js, line 1803 -
Changes target URL for forwarding rule. The new target should be of the same type as the old target.
Name Type Description paramsobject Parameters for request
Name Type Description forwardingRulestring Name of the ForwardingRule resource in which target is to be set.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).TargetReference Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.forwardingRules.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 1834 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The name of the region for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalAddresses.delete(params, callback){object}
apis/compute/alpha.js, line 1867 -
Deletes the specified address resource.
Name Type Description paramsobject Parameters for request
Name Type Description addressstring Name of the address resource to delete.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalAddresses.get(params, callback){object}
apis/compute/alpha.js, line 1896 -
Returns the specified address resource. Get a list of available addresses by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description addressstring Name of the address resource to return.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalAddresses.insert(params, callback){object}
apis/compute/alpha.js, line 1925 -
Creates an address resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).Address Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalAddresses.list(params, callback){object}
apis/compute/alpha.js, line 1957 -
Retrieves a list of global addresses.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalAddresses.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 1987 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalForwardingRules.delete(params, callback){object}
apis/compute/alpha.js, line 2020 -
Deletes the specified ForwardingRule resource.
Name Type Description paramsobject Parameters for request
Name Type Description forwardingRulestring Name of the ForwardingRule resource to delete.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalForwardingRules.get(params, callback){object}
apis/compute/alpha.js, line 2049 -
Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description forwardingRulestring Name of the ForwardingRule resource to return.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalForwardingRules.insert(params, callback){object}
apis/compute/alpha.js, line 2078 -
Creates a ForwardingRule resource in the specified project and region using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).ForwardingRule Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalForwardingRules.list(params, callback){object}
apis/compute/alpha.js, line 2110 -
Retrieves a list of ForwardingRule resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalForwardingRules.setTarget(params, callback){object}
apis/compute/alpha.js, line 2140 -
Changes target URL for forwarding rule. The new target should be of the same type as the old target.
Name Type Description paramsobject Parameters for request
Name Type Description forwardingRulestring Name of the ForwardingRule resource in which target is to be set.
projectstring Project ID for this request.
resourcecompute(alpha).TargetReference Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalForwardingRules.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 2170 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalOperations.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 2206 -
Retrieves an aggregated list of all operations.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalOperations.delete(params, callback){object}
apis/compute/alpha.js, line 2235 -
Deletes the specified Operations resource.
Name Type Description paramsobject Parameters for request
Name Type Description operationstring Name of the Operations resource to delete.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalOperations.get(params, callback){object}
apis/compute/alpha.js, line 2264 -
Retrieves the specified Operations resource. Get a list of operations by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description operationstring Name of the Operations resource to return.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.globalOperations.list(params, callback){object}
apis/compute/alpha.js, line 2296 -
Retrieves a list of Operation resources contained within the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.healthChecks.delete(params, callback){object}
apis/compute/alpha.js, line 2329 -
Deletes the specified HealthCheck resource.
Name Type Description paramsobject Parameters for request
Name Type Description healthCheckstring Name of the HealthCheck resource to delete.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.healthChecks.get(params, callback){object}
apis/compute/alpha.js, line 2358 -
Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description healthCheckstring Name of the HealthCheck resource to return.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.healthChecks.insert(params, callback){object}
apis/compute/alpha.js, line 2387 -
Creates a HealthCheck resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).HealthCheck Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.healthChecks.list(params, callback){object}
apis/compute/alpha.js, line 2419 -
Retrieves the list of HealthCheck resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.healthChecks.patch(params, callback){object}
apis/compute/alpha.js, line 2449 -
Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
Name Type Description paramsobject Parameters for request
Name Type Description healthCheckstring Name of the HealthCheck resource to update.
projectstring Project ID for this request.
resourcecompute(alpha).HealthCheck Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.healthChecks.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 2479 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.healthChecks.update(params, callback){object}
apis/compute/alpha.js, line 2509 -
Updates a HealthCheck resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description healthCheckstring Name of the HealthCheck resource to update.
projectstring Project ID for this request.
resourcecompute(alpha).HealthCheck Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.httpHealthChecks.delete(params, callback){object}
apis/compute/alpha.js, line 2542 -
Deletes the specified HttpHealthCheck resource.
Name Type Description paramsobject Parameters for request
Name Type Description httpHealthCheckstring Name of the HttpHealthCheck resource to delete.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.httpHealthChecks.get(params, callback){object}
apis/compute/alpha.js, line 2571 -
Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description httpHealthCheckstring Name of the HttpHealthCheck resource to return.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.httpHealthChecks.insert(params, callback){object}
apis/compute/alpha.js, line 2600 -
Creates a HttpHealthCheck resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).HttpHealthCheck Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.httpHealthChecks.list(params, callback){object}
apis/compute/alpha.js, line 2632 -
Retrieves the list of HttpHealthCheck resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.httpHealthChecks.patch(params, callback){object}
apis/compute/alpha.js, line 2662 -
Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
Name Type Description paramsobject Parameters for request
Name Type Description httpHealthCheckstring Name of the HttpHealthCheck resource to update.
projectstring Project ID for this request.
resourcecompute(alpha).HttpHealthCheck Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.httpHealthChecks.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 2692 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.httpHealthChecks.update(params, callback){object}
apis/compute/alpha.js, line 2722 -
Updates a HttpHealthCheck resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description httpHealthCheckstring Name of the HttpHealthCheck resource to update.
projectstring Project ID for this request.
resourcecompute(alpha).HttpHealthCheck Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.httpsHealthChecks.delete(params, callback){object}
apis/compute/alpha.js, line 2755 -
Deletes the specified HttpsHealthCheck resource.
Name Type Description paramsobject Parameters for request
Name Type Description httpsHealthCheckstring Name of the HttpsHealthCheck resource to delete.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.httpsHealthChecks.get(params, callback){object}
apis/compute/alpha.js, line 2784 -
Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description httpsHealthCheckstring Name of the HttpsHealthCheck resource to return.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.httpsHealthChecks.insert(params, callback){object}
apis/compute/alpha.js, line 2813 -
Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).HttpsHealthCheck Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.httpsHealthChecks.list(params, callback){object}
apis/compute/alpha.js, line 2845 -
Retrieves the list of HttpsHealthCheck resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.httpsHealthChecks.patch(params, callback){object}
apis/compute/alpha.js, line 2875 -
Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
Name Type Description paramsobject Parameters for request
Name Type Description httpsHealthCheckstring Name of the HttpsHealthCheck resource to update.
projectstring Project ID for this request.
resourcecompute(alpha).HttpsHealthCheck Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.httpsHealthChecks.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 2905 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.httpsHealthChecks.update(params, callback){object}
apis/compute/alpha.js, line 2935 -
Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description httpsHealthCheckstring Name of the HttpsHealthCheck resource to update.
projectstring Project ID for this request.
resourcecompute(alpha).HttpsHealthCheck Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.images.delete(params, callback){object}
apis/compute/alpha.js, line 2968 -
Deletes the specified image.
Name Type Description paramsobject Parameters for request
Name Type Description imagestring Name of the image resource to delete.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.images.deprecate(params, callback){object}
apis/compute/alpha.js, line 2998 -
Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.
Name Type Description paramsobject Parameters for request
Name Type Description imagestring Image name.
projectstring Project ID for this request.
resourcecompute(alpha).DeprecationStatus Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.images.get(params, callback){object}
apis/compute/alpha.js, line 3027 -
Returns the specified image. Get a list of available images by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description imagestring Name of the image resource to return.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.images.getFromFamily(params, callback){object}
apis/compute/alpha.js, line 3056 -
Returns the latest image that is part of an image family and is not deprecated.
Name Type Description paramsobject Parameters for request
Name Type Description familystring Name of the image family to search for.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.images.insert(params, callback){object}
apis/compute/alpha.js, line 3085 -
Creates an image in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).Image Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.images.list(params, callback){object}
apis/compute/alpha.js, line 3117 -
Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.images.setLabels(params, callback){object}
apis/compute/alpha.js, line 3147 -
Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).GlobalSetLabelsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.images.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 3177 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.abandonInstances(params, callback){object}
apis/compute/alpha.js, line 3212 -
Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the managed instance group.
projectstring Project ID for this request.
zonestring The name of the zone where the managed instance group is located.
resourcecompute(alpha).InstanceGroupManagersAbandonInstancesRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 3244 -
Retrieves the list of managed instance groups and groups them by zone.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.delete(params, callback){object}
apis/compute/alpha.js, line 3274 -
Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the managed instance group to delete.
projectstring Project ID for this request.
zonestring The name of the zone where the managed instance group is located.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.deleteInstances(params, callback){object}
apis/compute/alpha.js, line 3305 -
Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the managed instance group.
projectstring Project ID for this request.
zonestring The name of the zone where the managed instance group is located.
resourcecompute(alpha).InstanceGroupManagersDeleteInstancesRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.get(params, callback){object}
apis/compute/alpha.js, line 3335 -
Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the managed instance group.
projectstring Project ID for this request.
zonestring The name of the zone where the managed instance group is located.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.insert(params, callback){object}
apis/compute/alpha.js, line 3365 -
Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
zonestring The name of the zone where you want to create the managed instance group.
resourcecompute(alpha).InstanceGroupManager Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.list(params, callback){object}
apis/compute/alpha.js, line 3398 -
Retrieves a list of managed instance groups that are contained within the specified project and zone.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
zonestring The name of the zone where the managed instance group is located.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.listManagedInstances(params, callback){object}
apis/compute/alpha.js, line 3428 -
Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the managed instance group.
projectstring Project ID for this request.
zonestring The name of the zone where the managed instance group is located.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.patch(params, callback){object}
apis/compute/alpha.js, line 3459 -
Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the instance group manager.
projectstring Project ID for this request.
zonestring The name of the zone where you want to create the managed instance group.
resourcecompute(alpha).InstanceGroupManager Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.recreateInstances(params, callback){object}
apis/compute/alpha.js, line 3490 -
Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the managed instance group.
projectstring Project ID for this request.
zonestring The name of the zone where the managed instance group is located.
resourcecompute(alpha).InstanceGroupManagersRecreateInstancesRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.resize(params, callback){object}
apis/compute/alpha.js, line 3521 -
Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the managed instance group.
projectstring Project ID for this request.
sizeinteger The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.
zonestring The name of the zone where the managed instance group is located.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.resizeAdvanced(params, callback){object}
apis/compute/alpha.js, line 3552 -
Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the managed instance group.
projectstring Project ID for this request.
zonestring The name of the zone where the managed instance group is located.
resourcecompute(alpha).InstanceGroupManagersResizeAdvancedRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.setAutoHealingPolicies(params, callback){object}
apis/compute/alpha.js, line 3583 -
Modifies the autohealing policies.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the instance group manager.
projectstring Project ID for this request.
zonestring The name of the zone where the managed instance group is located.
resourcecompute(alpha).InstanceGroupManagersSetAutoHealingRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.setInstanceTemplate(params, callback){object}
apis/compute/alpha.js, line 3614 -
Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the managed instance group.
projectstring Project ID for this request.
zonestring The name of the zone where the managed instance group is located.
resourcecompute(alpha).InstanceGroupManagersSetInstanceTemplateRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.setTargetPools(params, callback){object}
apis/compute/alpha.js, line 3645 -
Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the managed instance group.
projectstring Project ID for this request.
zonestring The name of the zone where the managed instance group is located.
resourcecompute(alpha).InstanceGroupManagersSetTargetPoolsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 3676 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroupManagers.update(params, callback){object}
apis/compute/alpha.js, line 3707 -
Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the instance group manager.
projectstring Project ID for this request.
zonestring The name of the zone where you want to create the managed instance group.
resourcecompute(alpha).InstanceGroupManager Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroups.addInstances(params, callback){object}
apis/compute/alpha.js, line 3742 -
Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupstring The name of the instance group where you are adding instances.
projectstring Project ID for this request.
zonestring The name of the zone where the instance group is located.
resourcecompute(alpha).InstanceGroupsAddInstancesRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroups.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 3774 -
Retrieves the list of instance groups and sorts them by zone.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroups.delete(params, callback){object}
apis/compute/alpha.js, line 3804 -
Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupstring The name of the instance group to delete.
projectstring Project ID for this request.
zonestring The name of the zone where the instance group is located.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroups.get(params, callback){object}
apis/compute/alpha.js, line 3834 -
Returns the specified instance group. Get a list of available instance groups by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupstring The name of the instance group.
projectstring Project ID for this request.
zonestring The name of the zone where the instance group is located.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroups.insert(params, callback){object}
apis/compute/alpha.js, line 3864 -
Creates an instance group in the specified project using the parameters that are included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
zonestring The name of the zone where you want to create the instance group.
resourcecompute(alpha).InstanceGroup Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroups.list(params, callback){object}
apis/compute/alpha.js, line 3897 -
Retrieves the list of instance groups that are located in the specified project and zone.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
zonestring The name of the zone where the instance group is located.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroups.listInstances(params, callback){object}
apis/compute/alpha.js, line 3932 -
Lists the instances in the specified instance group.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
instanceGroupstring The name of the instance group from which you want to generate a list of included instances.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
zonestring The name of the zone where the instance group is located.
resourcecompute(alpha).InstanceGroupsListInstancesRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroups.removeInstances(params, callback){object}
apis/compute/alpha.js, line 3963 -
Removes one or more instances from the specified instance group, but does not delete those instances.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupstring The name of the instance group where the specified instances will be removed.
projectstring Project ID for this request.
zonestring The name of the zone where the instance group is located.
resourcecompute(alpha).InstanceGroupsRemoveInstancesRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroups.setNamedPorts(params, callback){object}
apis/compute/alpha.js, line 3994 -
Sets the named ports for the specified instance group.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupstring The name of the instance group where the named ports are updated.
projectstring Project ID for this request.
zonestring The name of the zone where the instance group is located.
resourcecompute(alpha).InstanceGroupsSetNamedPortsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceGroups.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 4025 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.addAccessConfig(params, callback){object}
apis/compute/alpha.js, line 4214 -
Adds an access config to an instance's network interface.
Name Type Description paramsobject Parameters for request
Name Type Description instancestring The instance name for this request.
networkInterfacestring The name of the network interface to add to this instance.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).AccessConfig Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 4246 -
Retrieves aggregated list of instances.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.attachDisk(params, callback){object}
apis/compute/alpha.js, line 4277 -
Attaches a Disk resource to an instance.
Name Type Description paramsobject Parameters for request
Name Type Description instancestring The instance name for this request.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).AttachedDisk Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.delete(params, callback){object}
apis/compute/alpha.js, line 4307 -
Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.
Name Type Description paramsobject Parameters for request
Name Type Description instancestring Name of the instance resource to delete.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.deleteAccessConfig(params, callback){object}
apis/compute/alpha.js, line 4339 -
Deletes an access config from an instance's network interface.
Name Type Description paramsobject Parameters for request
Name Type Description accessConfigstring The name of the access config to delete.
instancestring The instance name for this request.
networkInterfacestring The name of the network interface.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.detachDisk(params, callback){object}
apis/compute/alpha.js, line 4370 -
Detaches a disk from an instance.
Name Type Description paramsobject Parameters for request
Name Type Description deviceNamestring Disk device name to detach.
instancestring Instance name.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.get(params, callback){object}
apis/compute/alpha.js, line 4400 -
Returns the specified Instance resource. Get a list of available instances by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description instancestring Name of the instance resource to return.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.getIamPolicy(params, callback){object}
apis/compute/alpha.js, line 4430 -
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.getSerialPortOutput(params, callback){object}
apis/compute/alpha.js, line 4462 -
Returns the specified instance's serial port output.
Name Type Description paramsobject Parameters for request
Name Type Description instancestring Name of the instance scoping this request.
portinteger optional Specifies which COM or serial port to retrieve data from.
projectstring Project ID for this request.
startstring optional For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value that was returned in the previous call.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.insert(params, callback){object}
apis/compute/alpha.js, line 4492 -
Creates an instance resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).Instance Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.list(params, callback){object}
apis/compute/alpha.js, line 4525 -
Retrieves the list of instances contained within the specified zone.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.reset(params, callback){object}
apis/compute/alpha.js, line 4555 -
Performs a hard reset on the instance.
Name Type Description paramsobject Parameters for request
Name Type Description instancestring Name of the instance scoping this request.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.setDiskAutoDelete(params, callback){object}
apis/compute/alpha.js, line 4587 -
Sets the auto-delete flag for a disk attached to an instance.
Name Type Description paramsobject Parameters for request
Name Type Description autoDeleteboolean Whether to auto-delete the disk when the instance is deleted.
deviceNamestring The device name of the disk to modify.
instancestring The instance name.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.setIamPolicy(params, callback){object}
apis/compute/alpha.js, line 4618 -
Sets the access control policy on the specified resource. Replaces any existing policy.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).Policy Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.setLabels(params, callback){object}
apis/compute/alpha.js, line 4649 -
Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation.
Name Type Description paramsobject Parameters for request
Name Type Description instancestring Name of the instance scoping this request.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).InstancesSetLabelsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.setMachineType(params, callback){object}
apis/compute/alpha.js, line 4680 -
Changes the machine type for a stopped instance to the machine type specified in the request.
Name Type Description paramsobject Parameters for request
Name Type Description instancestring Name of the instance scoping this request.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).InstancesSetMachineTypeRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.setMetadata(params, callback){object}
apis/compute/alpha.js, line 4711 -
Sets metadata for the specified instance to the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description instancestring Name of the instance scoping this request.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).Metadata Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.setScheduling(params, callback){object}
apis/compute/alpha.js, line 4742 -
Sets an instance's scheduling options.
Name Type Description paramsobject Parameters for request
Name Type Description instancestring Instance name.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).Scheduling Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.setServiceAccount(params, callback){object}
apis/compute/alpha.js, line 4773 -
Sets the service account on the instance.
Name Type Description paramsobject Parameters for request
Name Type Description instancestring Name of the instance resource to start.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).InstancesSetServiceAccountRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.setTags(params, callback){object}
apis/compute/alpha.js, line 4804 -
Sets tags for the specified instance to the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description instancestring Name of the instance scoping this request.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).Tags Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.start(params, callback){object}
apis/compute/alpha.js, line 4834 -
Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
Name Type Description paramsobject Parameters for request
Name Type Description instancestring Name of the instance resource to start.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.startWithEncryptionKey(params, callback){object}
apis/compute/alpha.js, line 4865 -
Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
Name Type Description paramsobject Parameters for request
Name Type Description instancestring Name of the instance resource to start.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).InstancesStartWithEncryptionKeyRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.stop(params, callback){object}
apis/compute/alpha.js, line 4896 -
Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.
Name Type Description paramsobject Parameters for request
Name Type Description discardLocalSsdboolean optional If true, discard the contents of any attached localSSD partitions. Default value is false.
instancestring Name of the instance resource to stop.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.suspend(params, callback){object}
apis/compute/alpha.js, line 4927 -
This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted.
Name Type Description paramsobject Parameters for request
Name Type Description discardLocalSsdboolean optional If true, discard the contents of any attached localSSD partitions. Default value is false.
instancestring Name of the instance resource to suspend.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instances.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 4958 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceTemplates.delete(params, callback){object}
apis/compute/alpha.js, line 4058 -
Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.
Name Type Description paramsobject Parameters for request
Name Type Description instanceTemplatestring The name of the instance template to delete.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceTemplates.get(params, callback){object}
apis/compute/alpha.js, line 4087 -
Returns the specified instance template. Get a list of available instance templates by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description instanceTemplatestring The name of the instance template.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceTemplates.insert(params, callback){object}
apis/compute/alpha.js, line 4116 -
Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).InstanceTemplate Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceTemplates.list(params, callback){object}
apis/compute/alpha.js, line 4148 -
Retrieves a list of instance templates that are contained within the specified project and zone.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.instanceTemplates.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 4178 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.licenses.get(params, callback){object}
apis/compute/alpha.js, line 4991 -
Returns the specified License resource. Get a list of available licenses by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description licensestring Name of the License resource to return.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.machineTypes.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 5027 -
Retrieves an aggregated list of machine types.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.machineTypes.get(params, callback){object}
apis/compute/alpha.js, line 5057 -
Returns the specified machine type. Get a list of available machine types by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description machineTypestring Name of the machine type to return.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.machineTypes.list(params, callback){object}
apis/compute/alpha.js, line 5090 -
Retrieves a list of machine types available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
zonestring The name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.networks.delete(params, callback){object}
apis/compute/alpha.js, line 5123 -
Deletes the specified network.
Name Type Description paramsobject Parameters for request
Name Type Description networkstring Name of the network to delete.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.networks.get(params, callback){object}
apis/compute/alpha.js, line 5152 -
Returns the specified network. Get a list of available networks by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description networkstring Name of the network to return.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.networks.insert(params, callback){object}
apis/compute/alpha.js, line 5181 -
Creates a network in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).Network Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.networks.list(params, callback){object}
apis/compute/alpha.js, line 5213 -
Retrieves the list of networks available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.networks.switchToCustomMode(params, callback){object}
apis/compute/alpha.js, line 5242 -
Switches the network mode from auto subnet mode to custom subnet mode.
Name Type Description paramsobject Parameters for request
Name Type Description networkstring Name of the network to be updated.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.networks.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 5272 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.projects.disableXpnHost(params, callback){object}
apis/compute/alpha.js, line 5304 -
Disable this project as an XPN host project.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.projects.disableXpnResource(params, callback){object}
apis/compute/alpha.js, line 5333 -
Disable an XPN resource associated with this host project.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).ProjectsDisableXpnResourceRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.projects.enableXpnHost(params, callback){object}
apis/compute/alpha.js, line 5361 -
Enable this project as an XPN host project.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.projects.enableXpnResource(params, callback){object}
apis/compute/alpha.js, line 5390 -
Enable XPN resource (a.k.a service project or service folder in the future) for a host project, so that subnetworks in the host project can be used by instances in the service project or folder.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).ProjectsEnableXpnResourceRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.projects.get(params, callback){object}
apis/compute/alpha.js, line 5418 -
Returns the specified Project resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.projects.getXpnHost(params, callback){object}
apis/compute/alpha.js, line 5446 -
Get the XPN host project that this project links to. May be empty if no link exists.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.projects.getXpnResources(params, callback){object}
apis/compute/alpha.js, line 5474 -
Get XPN resources associated with this host project.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.projects.listXpnHosts(params, callback){object}
apis/compute/alpha.js, line 5503 -
List all XPN host projects visible to the user in an organization.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).ProjectsListXpnHostsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.projects.moveDisk(params, callback){object}
apis/compute/alpha.js, line 5532 -
Moves a persistent disk from one zone to another.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).DiskMoveRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.projects.moveInstance(params, callback){object}
apis/compute/alpha.js, line 5561 -
Moves an instance and its attached persistent disks from one zone to another.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).InstanceMoveRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.projects.setCommonInstanceMetadata(params, callback){object}
apis/compute/alpha.js, line 5590 -
Sets metadata common to all instances within the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).Metadata Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.projects.setUsageExportBucket(params, callback){object}
apis/compute/alpha.js, line 5619 -
Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).UsageExportLocation Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionAutoscalers.delete(params, callback){object}
apis/compute/alpha.js, line 5653 -
Deletes the specified autoscaler.
Name Type Description paramsobject Parameters for request
Name Type Description autoscalerstring Name of the autoscaler to delete.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionAutoscalers.get(params, callback){object}
apis/compute/alpha.js, line 5683 -
Returns the specified autoscaler.
Name Type Description paramsobject Parameters for request
Name Type Description autoscalerstring Name of the autoscaler to return.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionAutoscalers.insert(params, callback){object}
apis/compute/alpha.js, line 5713 -
Creates an autoscaler in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).Autoscaler Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionAutoscalers.list(params, callback){object}
apis/compute/alpha.js, line 5746 -
Retrieves a list of autoscalers contained within the specified region.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionAutoscalers.patch(params, callback){object}
apis/compute/alpha.js, line 5777 -
Updates a autoscaler in the specified project using the data included in the request. This method supports patch semantics.
Name Type Description paramsobject Parameters for request
Name Type Description autoscalerstring Name of the autoscaler to update.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).Autoscaler Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionAutoscalers.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 5808 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The name of the region for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionAutoscalers.update(params, callback){object}
apis/compute/alpha.js, line 5839 -
Updates a autoscaler in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description autoscalerstring optional Name of the autoscaler to update.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).Autoscaler Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionBackendServices.delete(params, callback){object}
apis/compute/alpha.js, line 5873 -
Deletes the specified regional BackendService resource.
Name Type Description paramsobject Parameters for request
Name Type Description backendServicestring Name of the BackendService resource to delete.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionBackendServices.get(params, callback){object}
apis/compute/alpha.js, line 5903 -
Returns the specified regional BackendService resource.
Name Type Description paramsobject Parameters for request
Name Type Description backendServicestring Name of the BackendService resource to return.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionBackendServices.getHealth(params, callback){object}
apis/compute/alpha.js, line 5934 -
Gets the most recent health check results for this regional BackendService.
Name Type Description paramsobject Parameters for request
Name Type Description backendServicestring Name of the BackendService resource to which the queried instance belongs.
projectstring regionstring Name of the region scoping this request.
resourcecompute(alpha).ResourceGroupReference Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionBackendServices.insert(params, callback){object}
apis/compute/alpha.js, line 5964 -
Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).BackendService Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionBackendServices.list(params, callback){object}
apis/compute/alpha.js, line 5997 -
Retrieves the list of regional BackendService resources available to the specified project in the given region.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionBackendServices.patch(params, callback){object}
apis/compute/alpha.js, line 6028 -
Update the entire content of the regional BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.
Name Type Description paramsobject Parameters for request
Name Type Description backendServicestring Name of the BackendService resource to update.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).BackendService Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionBackendServices.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 6059 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The name of the region for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionBackendServices.update(params, callback){object}
apis/compute/alpha.js, line 6090 -
Update the entire content of the regional BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.
Name Type Description paramsobject Parameters for request
Name Type Description backendServicestring Name of the BackendService resource to update.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).BackendService Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionDisks.createSnapshot(params, callback){object}
apis/compute/alpha.js, line 6193 -
Creates a snapshot of this regional disk.
Name Type Description paramsobject Parameters for request
Name Type Description diskstring Name of the regional persistent disk to snapshot.
guestFlushboolean optional projectstring Project ID for this request.
regionstring Name of the region for this request.
resourcecompute(alpha).Snapshot Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionDisks.delete(params, callback){object}
apis/compute/alpha.js, line 6223 -
Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.
Name Type Description paramsobject Parameters for request
Name Type Description diskstring Name of the regional persistent disk to delete.
projectstring Project ID for this request.
regionstring Name of the region for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionDisks.get(params, callback){object}
apis/compute/alpha.js, line 6253 -
Returns a specified regional persistent disk.
Name Type Description paramsobject Parameters for request
Name Type Description diskstring Name of the regional persistent disk to return.
projectstring Project ID for this request.
regionstring Name of the region for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionDisks.insert(params, callback){object}
apis/compute/alpha.js, line 6284 -
Creates a persistent regional disk in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
sourceImagestring optional Optional. Source image to restore onto a disk.
resourcecompute(alpha).Disk Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionDisks.list(params, callback){object}
apis/compute/alpha.js, line 6317 -
Retrieves the list of persistent disks contained within the specified region.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring Name of the region for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionDisks.resize(params, callback){object}
apis/compute/alpha.js, line 6348 -
Resizes the specified regional persistent disk.
Name Type Description paramsobject Parameters for request
Name Type Description diskstring Name of the regional persistent disk.
projectstring The project ID for this request.
regionstring Name of the region for this request.
resourcecompute(alpha).RegionDisksResizeRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionDisks.setLabels(params, callback){object}
apis/compute/alpha.js, line 6379 -
Sets the labels on the target regional disk.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The region for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).RegionSetLabelsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionDisks.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 6410 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The name of the region for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionDiskTypes.get(params, callback){object}
apis/compute/alpha.js, line 6124 -
Returns the specified regional disk type. Get a list of available disk types by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description diskTypestring Name of the disk type to return.
projectstring Project ID for this request.
regionstring The name of the region for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionDiskTypes.list(params, callback){object}
apis/compute/alpha.js, line 6157 -
Retrieves a list of regional disk types available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring The name of the region for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroupManagers.abandonInstances(params, callback){object}
apis/compute/alpha.js, line 6445 -
Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring Name of the managed instance group.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).RegionInstanceGroupManagersAbandonInstancesRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroupManagers.delete(params, callback){object}
apis/compute/alpha.js, line 6475 -
Deletes the specified managed instance group and all of the instances in that group.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring Name of the managed instance group to delete.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroupManagers.deleteInstances(params, callback){object}
apis/compute/alpha.js, line 6506 -
Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring Name of the managed instance group.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).RegionInstanceGroupManagersDeleteInstancesRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroupManagers.get(params, callback){object}
apis/compute/alpha.js, line 6536 -
Returns all of the details for the specified managed instance group.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring Name of the managed instance group to return.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroupManagers.insert(params, callback){object}
apis/compute/alpha.js, line 6566 -
Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).InstanceGroupManager Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroupManagers.list(params, callback){object}
apis/compute/alpha.js, line 6599 -
Retrieves the list of managed instance groups that are contained within the specified region.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroupManagers.listManagedInstances(params, callback){object}
apis/compute/alpha.js, line 6629 -
Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the managed instance group.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroupManagers.recreateInstances(params, callback){object}
apis/compute/alpha.js, line 6660 -
Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring Name of the managed instance group.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).RegionInstanceGroupManagersRecreateRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroupManagers.resize(params, callback){object}
apis/compute/alpha.js, line 6691 -
Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring Name of the managed instance group.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
sizeinteger Number of instances that should exist in this instance group manager.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroupManagers.setAutoHealingPolicies(params, callback){object}
apis/compute/alpha.js, line 6722 -
Modifies the autohealing policy for the instances in this managed instance group.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring Name of the managed instance group.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).RegionInstanceGroupManagersSetAutoHealingRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroupManagers.setInstanceTemplate(params, callback){object}
apis/compute/alpha.js, line 6753 -
Sets the instance template to use when creating new instances in this group. Existing instances are not affected.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring The name of the managed instance group.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).RegionInstanceGroupManagersSetTemplateRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroupManagers.setTargetPools(params, callback){object}
apis/compute/alpha.js, line 6784 -
Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupManagerstring Name of the managed instance group.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).RegionInstanceGroupManagersSetTargetPoolsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroupManagers.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 6815 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The name of the region for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroups.get(params, callback){object}
apis/compute/alpha.js, line 6849 -
Returns the specified instance group resource.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupstring Name of the instance group resource to return.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroups.list(params, callback){object}
apis/compute/alpha.js, line 6882 -
Retrieves the list of instance group resources contained within the specified region.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroups.listInstances(params, callback){object}
apis/compute/alpha.js, line 6917 -
Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
instanceGroupstring Name of the regional instance group for which we want to list the instances.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).RegionInstanceGroupsListInstancesRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroups.setNamedPorts(params, callback){object}
apis/compute/alpha.js, line 6948 -
Sets the named ports for the specified regional instance group.
Name Type Description paramsobject Parameters for request
Name Type Description instanceGroupstring The name of the regional instance group where the named ports are updated.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).RegionInstanceGroupsSetNamedPortsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionInstanceGroups.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 6979 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The name of the region for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionOperations.delete(params, callback){object}
apis/compute/alpha.js, line 7013 -
Deletes the specified region-specific Operations resource.
Name Type Description paramsobject Parameters for request
Name Type Description operationstring Name of the Operations resource to delete.
projectstring Project ID for this request.
regionstring Name of the region for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionOperations.get(params, callback){object}
apis/compute/alpha.js, line 7043 -
Retrieves the specified region-specific Operations resource.
Name Type Description paramsobject Parameters for request
Name Type Description operationstring Name of the Operations resource to return.
projectstring Project ID for this request.
regionstring Name of the region for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regionOperations.list(params, callback){object}
apis/compute/alpha.js, line 7076 -
Retrieves a list of Operation resources contained within the specified region.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring Name of the region for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regions.get(params, callback){object}
apis/compute/alpha.js, line 7109 -
Returns the specified Region resource. Get a list of available regions by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region resource to return.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.regions.list(params, callback){object}
apis/compute/alpha.js, line 7141 -
Retrieves the list of region resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routers.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 7177 -
Retrieves an aggregated list of routers.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routers.delete(params, callback){object}
apis/compute/alpha.js, line 7207 -
Deletes the specified Router resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
routerstring Name of the Router resource to delete.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routers.get(params, callback){object}
apis/compute/alpha.js, line 7237 -
Returns the specified Router resource. Get a list of available routers by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
routerstring Name of the Router resource to return.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routers.getRouterStatus(params, callback){object}
apis/compute/alpha.js, line 7267 -
Retrieves runtime information of the specified router.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
routerstring Name of the Router resource to query.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routers.insert(params, callback){object}
apis/compute/alpha.js, line 7297 -
Creates a Router resource in the specified project and region using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
resourcecompute(alpha).Router Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routers.list(params, callback){object}
apis/compute/alpha.js, line 7330 -
Retrieves a list of Router resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring Name of the region for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routers.patch(params, callback){object}
apis/compute/alpha.js, line 7361 -
Updates the entire content of the Router resource. This method supports patch semantics.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
routerstring Name of the Router resource to update.
resourcecompute(alpha).Router Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routers.preview(params, callback){object}
apis/compute/alpha.js, line 7392 -
Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
routerstring Name of the Router resource to query.
resourcecompute(alpha).Router Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routers.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 7423 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The name of the region for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routers.update(params, callback){object}
apis/compute/alpha.js, line 7454 -
Updates the entire content of the Router resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
routerstring Name of the Router resource to update.
resourcecompute(alpha).Router Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routes.delete(params, callback){object}
apis/compute/alpha.js, line 7487 -
Deletes the specified Route resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
routestring Name of the Route resource to delete.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routes.get(params, callback){object}
apis/compute/alpha.js, line 7516 -
Returns the specified Route resource. Get a list of available routes by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
routestring Name of the Route resource to return.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routes.insert(params, callback){object}
apis/compute/alpha.js, line 7545 -
Creates a Route resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).Route Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routes.list(params, callback){object}
apis/compute/alpha.js, line 7577 -
Retrieves the list of Route resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.routes.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 7607 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.snapshots.delete(params, callback){object}
apis/compute/alpha.js, line 7640 -
Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snaphots.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
snapshotstring Name of the Snapshot resource to delete.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.snapshots.get(params, callback){object}
apis/compute/alpha.js, line 7669 -
Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
snapshotstring Name of the Snapshot resource to return.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.snapshots.list(params, callback){object}
apis/compute/alpha.js, line 7701 -
Retrieves the list of Snapshot resources contained within the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.snapshots.setLabels(params, callback){object}
apis/compute/alpha.js, line 7731 -
Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).GlobalSetLabelsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.snapshots.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 7761 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.sslCertificates.delete(params, callback){object}
apis/compute/alpha.js, line 7794 -
Deletes the specified SslCertificate resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
sslCertificatestring Name of the SslCertificate resource to delete.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.sslCertificates.get(params, callback){object}
apis/compute/alpha.js, line 7823 -
Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
sslCertificatestring Name of the SslCertificate resource to return.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.sslCertificates.insert(params, callback){object}
apis/compute/alpha.js, line 7852 -
Creates a SslCertificate resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).SslCertificate Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.sslCertificates.list(params, callback){object}
apis/compute/alpha.js, line 7884 -
Retrieves the list of SslCertificate resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.sslCertificates.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 7914 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.subnetworks.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 7950 -
Retrieves an aggregated list of subnetworks.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.subnetworks.delete(params, callback){object}
apis/compute/alpha.js, line 7980 -
Deletes the specified subnetwork.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
subnetworkstring Name of the Subnetwork resource to delete.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.subnetworks.expandIpCidrRange(params, callback){object}
apis/compute/alpha.js, line 8011 -
Expands the IP CIDR range of the subnetwork to a specified value.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
subnetworkstring Name of the Subnetwork resource to update.
resourcecompute(alpha).SubnetworksExpandIpCidrRangeRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.subnetworks.get(params, callback){object}
apis/compute/alpha.js, line 8041 -
Returns the specified subnetwork. Get a list of available subnetworks list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
subnetworkstring Name of the Subnetwork resource to return.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.subnetworks.getIamPolicy(params, callback){object}
apis/compute/alpha.js, line 8071 -
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The name of the region for this request.
resource_string Name of the resource for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.subnetworks.insert(params, callback){object}
apis/compute/alpha.js, line 8101 -
Creates a subnetwork in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).Subnetwork Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.subnetworks.list(params, callback){object}
apis/compute/alpha.js, line 8134 -
Retrieves a list of subnetworks available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.subnetworks.setIamPolicy(params, callback){object}
apis/compute/alpha.js, line 8165 -
Sets the access control policy on the specified resource. Replaces any existing policy.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The name of the region for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).Policy Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.subnetworks.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 8196 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The name of the region for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetHttpProxies.delete(params, callback){object}
apis/compute/alpha.js, line 8229 -
Deletes the specified TargetHttpProxy resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
targetHttpProxystring Name of the TargetHttpProxy resource to delete.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetHttpProxies.get(params, callback){object}
apis/compute/alpha.js, line 8258 -
Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
targetHttpProxystring Name of the TargetHttpProxy resource to return.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetHttpProxies.insert(params, callback){object}
apis/compute/alpha.js, line 8287 -
Creates a TargetHttpProxy resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).TargetHttpProxy Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetHttpProxies.list(params, callback){object}
apis/compute/alpha.js, line 8319 -
Retrieves the list of TargetHttpProxy resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetHttpProxies.setUrlMap(params, callback){object}
apis/compute/alpha.js, line 8349 -
Changes the URL map for TargetHttpProxy.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
targetHttpProxystring Name of the TargetHttpProxy to set a URL map for.
resourcecompute(alpha).UrlMapReference Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetHttpProxies.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 8379 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetHttpsProxies.delete(params, callback){object}
apis/compute/alpha.js, line 8412 -
Deletes the specified TargetHttpsProxy resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
targetHttpsProxystring Name of the TargetHttpsProxy resource to delete.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetHttpsProxies.get(params, callback){object}
apis/compute/alpha.js, line 8441 -
Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
targetHttpsProxystring Name of the TargetHttpsProxy resource to return.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetHttpsProxies.insert(params, callback){object}
apis/compute/alpha.js, line 8470 -
Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).TargetHttpsProxy Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetHttpsProxies.list(params, callback){object}
apis/compute/alpha.js, line 8502 -
Retrieves the list of TargetHttpsProxy resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetHttpsProxies.setSslCertificates(params, callback){object}
apis/compute/alpha.js, line 8532 -
Replaces SslCertificates for TargetHttpsProxy.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
targetHttpsProxystring Name of the TargetHttpsProxy resource to set an SslCertificates resource for.
resourcecompute(alpha).TargetHttpsProxiesSetSslCertificatesRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetHttpsProxies.setUrlMap(params, callback){object}
apis/compute/alpha.js, line 8562 -
Changes the URL map for TargetHttpsProxy.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
targetHttpsProxystring Name of the TargetHttpsProxy resource whose URL map is to be set.
resourcecompute(alpha).UrlMapReference Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetHttpsProxies.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 8592 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetInstances.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 8628 -
Retrieves an aggregated list of target instances.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetInstances.delete(params, callback){object}
apis/compute/alpha.js, line 8658 -
Deletes the specified TargetInstance resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
targetInstancestring Name of the TargetInstance resource to delete.
zonestring Name of the zone scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetInstances.get(params, callback){object}
apis/compute/alpha.js, line 8688 -
Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
targetInstancestring Name of the TargetInstance resource to return.
zonestring Name of the zone scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetInstances.insert(params, callback){object}
apis/compute/alpha.js, line 8718 -
Creates a TargetInstance resource in the specified project and zone using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
zonestring Name of the zone scoping this request.
resourcecompute(alpha).TargetInstance Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetInstances.list(params, callback){object}
apis/compute/alpha.js, line 8751 -
Retrieves a list of TargetInstance resources available to the specified project and zone.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
zonestring Name of the zone scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetInstances.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 8782 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
zonestring The name of the zone for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetPools.addHealthCheck(params, callback){object}
apis/compute/alpha.js, line 8817 -
Adds health check URLs to a target pool.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
targetPoolstring Name of the target pool to add a health check to.
resourcecompute(alpha).TargetPoolsAddHealthCheckRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetPools.addInstance(params, callback){object}
apis/compute/alpha.js, line 8848 -
Adds an instance to a target pool.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
targetPoolstring Name of the TargetPool resource to add instances to.
resourcecompute(alpha).TargetPoolsAddInstanceRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetPools.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 8880 -
Retrieves an aggregated list of target pools.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetPools.delete(params, callback){object}
apis/compute/alpha.js, line 8910 -
Deletes the specified target pool.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
targetPoolstring Name of the TargetPool resource to delete.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetPools.get(params, callback){object}
apis/compute/alpha.js, line 8940 -
Returns the specified target pool. Get a list of available target pools by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
targetPoolstring Name of the TargetPool resource to return.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetPools.getHealth(params, callback){object}
apis/compute/alpha.js, line 8971 -
Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
targetPoolstring Name of the TargetPool resource to which the queried instance belongs.
resourcecompute(alpha).InstanceReference Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetPools.insert(params, callback){object}
apis/compute/alpha.js, line 9001 -
Creates a target pool in the specified project and region using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
resourcecompute(alpha).TargetPool Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetPools.list(params, callback){object}
apis/compute/alpha.js, line 9034 -
Retrieves a list of target pools available to the specified project and region.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetPools.removeHealthCheck(params, callback){object}
apis/compute/alpha.js, line 9065 -
Removes health check URL from a target pool.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
targetPoolstring Name of the target pool to remove health checks from.
resourcecompute(alpha).TargetPoolsRemoveHealthCheckRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetPools.removeInstance(params, callback){object}
apis/compute/alpha.js, line 9096 -
Removes instance URL from a target pool.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region scoping this request.
targetPoolstring Name of the TargetPool resource to remove instances from.
resourcecompute(alpha).TargetPoolsRemoveInstanceRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetPools.setBackup(params, callback){object}
apis/compute/alpha.js, line 9128 -
Changes a backup target pool's configurations.
Name Type Description paramsobject Parameters for request
Name Type Description failoverRationumber optional New failoverRatio value for the target pool.
projectstring Project ID for this request.
regionstring Name of the region scoping this request.
targetPoolstring Name of the TargetPool resource to set a backup pool for.
resourcecompute(alpha).TargetReference Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetPools.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 9159 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The name of the region for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetSslProxies.delete(params, callback){object}
apis/compute/alpha.js, line 9192 -
Deletes the specified TargetSslProxy resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
targetSslProxystring Name of the TargetSslProxy resource to delete.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetSslProxies.get(params, callback){object}
apis/compute/alpha.js, line 9221 -
Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
targetSslProxystring Name of the TargetSslProxy resource to return.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetSslProxies.insert(params, callback){object}
apis/compute/alpha.js, line 9250 -
Creates a TargetSslProxy resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).TargetSslProxy Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetSslProxies.list(params, callback){object}
apis/compute/alpha.js, line 9282 -
Retrieves the list of TargetSslProxy resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetSslProxies.setBackendService(params, callback){object}
apis/compute/alpha.js, line 9312 -
Changes the BackendService for TargetSslProxy.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
targetSslProxystring Name of the TargetSslProxy resource whose BackendService resource is to be set.
resourcecompute(alpha).TargetSslProxiesSetBackendServiceRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetSslProxies.setProxyHeader(params, callback){object}
apis/compute/alpha.js, line 9342 -
Changes the ProxyHeaderType for TargetSslProxy.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
targetSslProxystring Name of the TargetSslProxy resource whose ProxyHeader is to be set.
resourcecompute(alpha).TargetSslProxiesSetProxyHeaderRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetSslProxies.setSslCertificates(params, callback){object}
apis/compute/alpha.js, line 9372 -
Changes SslCertificates for TargetSslProxy.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
targetSslProxystring Name of the TargetSslProxy resource whose SslCertificate resource is to be set.
resourcecompute(alpha).TargetSslProxiesSetSslCertificatesRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetSslProxies.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 9402 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetVpnGateways.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 9438 -
Retrieves an aggregated list of target VPN gateways.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetVpnGateways.delete(params, callback){object}
apis/compute/alpha.js, line 9468 -
Deletes the specified target VPN gateway.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
targetVpnGatewaystring Name of the target VPN gateway to delete.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetVpnGateways.get(params, callback){object}
apis/compute/alpha.js, line 9498 -
Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
targetVpnGatewaystring Name of the target VPN gateway to return.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetVpnGateways.insert(params, callback){object}
apis/compute/alpha.js, line 9528 -
Creates a target VPN gateway in the specified project and region using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
resourcecompute(alpha).TargetVpnGateway Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetVpnGateways.list(params, callback){object}
apis/compute/alpha.js, line 9561 -
Retrieves a list of target VPN gateways available to the specified project and region.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring Name of the region for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.targetVpnGateways.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 9592 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The name of the region for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.urlMaps.delete(params, callback){object}
apis/compute/alpha.js, line 9625 -
Deletes the specified UrlMap resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
urlMapstring Name of the UrlMap resource to delete.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.urlMaps.get(params, callback){object}
apis/compute/alpha.js, line 9654 -
Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
urlMapstring Name of the UrlMap resource to return.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.urlMaps.insert(params, callback){object}
apis/compute/alpha.js, line 9683 -
Creates a UrlMap resource in the specified project using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resourcecompute(alpha).UrlMap Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.urlMaps.invalidateCache(params, callback){object}
apis/compute/alpha.js, line 9713 -
Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
urlMapstring Name of the UrlMap scoping this request.
resourcecompute(alpha).CacheInvalidationRule Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.urlMaps.list(params, callback){object}
apis/compute/alpha.js, line 9745 -
Retrieves the list of UrlMap resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.urlMaps.patch(params, callback){object}
apis/compute/alpha.js, line 9775 -
Updates the entire content of the UrlMap resource. This method supports patch semantics.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
urlMapstring Name of the UrlMap resource to update.
resourcecompute(alpha).UrlMap Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.urlMaps.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 9805 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.urlMaps.update(params, callback){object}
apis/compute/alpha.js, line 9835 -
Updates the entire content of the UrlMap resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
urlMapstring Name of the UrlMap resource to update.
resourcecompute(alpha).UrlMap Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.urlMaps.validate(params, callback){object}
apis/compute/alpha.js, line 9865 -
Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
urlMapstring Name of the UrlMap resource to be validated as.
resourcecompute(alpha).UrlMapsValidateRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.vpnTunnels.aggregatedList(params, callback){object}
apis/compute/alpha.js, line 9901 -
Retrieves an aggregated list of VPN tunnels.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.vpnTunnels.delete(params, callback){object}
apis/compute/alpha.js, line 9931 -
Deletes the specified VpnTunnel resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
vpnTunnelstring Name of the VpnTunnel resource to delete.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.vpnTunnels.get(params, callback){object}
apis/compute/alpha.js, line 9961 -
Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
vpnTunnelstring Name of the VpnTunnel resource to return.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.vpnTunnels.insert(params, callback){object}
apis/compute/alpha.js, line 9991 -
Creates a VpnTunnel resource in the specified project and region using the data included in the request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring Name of the region for this request.
resourcecompute(alpha).VpnTunnel Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.vpnTunnels.list(params, callback){object}
apis/compute/alpha.js, line 10024 -
Retrieves a list of VpnTunnel resources contained in the specified project and region.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
regionstring Name of the region for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.vpnTunnels.testIamPermissions(params, callback){object}
apis/compute/alpha.js, line 10055 -
Returns permissions that a caller has on the specified resource.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
regionstring The name of the region for this request.
resource_string Name of the resource for this request.
resourcecompute(alpha).TestPermissionsRequest Request body data
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.zoneOperations.delete(params, callback){object}
apis/compute/alpha.js, line 10089 -
Deletes the specified zone-specific Operations resource.
Name Type Description paramsobject Parameters for request
Name Type Description operationstring Name of the Operations resource to delete.
projectstring Project ID for this request.
zonestring Name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.zoneOperations.get(params, callback){object}
apis/compute/alpha.js, line 10119 -
Retrieves the specified zone-specific Operations resource.
Name Type Description paramsobject Parameters for request
Name Type Description operationstring Name of the Operations resource to return.
projectstring Project ID for this request.
zonestring Name of the zone for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.zoneOperations.list(params, callback){object}
apis/compute/alpha.js, line 10152 -
Retrieves a list of Operation resources contained within the specified zone.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
zonestring Name of the zone for request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.zones.get(params, callback){object}
apis/compute/alpha.js, line 10185 -
Returns the specified Zone resource. Get a list of available zones by making a list() request.
Name Type Description paramsobject Parameters for request
Name Type Description projectstring Project ID for this request.
zonestring Name of the zone resource to return.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object -
staticcompute(alpha).compute.zones.list(params, callback){object}
apis/compute/alpha.js, line 10217 -
Retrieves the list of Zone resources available to the specified project.
Name Type Description paramsobject Parameters for request
Name Type Description filterstring optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
maxResultsinteger optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
orderBystring optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
pageTokenstring optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
projectstring Project ID for this request.
callbackcallback The callback that handles the response.
Returns:
Type Description object Request object
Type Definitions
-
compute(alpha).AccessConfigobject
-
Properties:
Name Type Description kindstring [Output Only] Type of the resource. Always compute#accessConfig for access configs.
namestring Name of this access configuration.
natIPstring An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
typestring The type of configuration. The default and only option is ONE_TO_ONE_NAT.
-
compute(alpha).Addressobject
-
Properties:
Name Type Description addressstring The static external IP address represented by this resource.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of the resource. Always compute#address for addresses.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
regionstring [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
selfLinkstring [Output Only] Server-defined URL for the resource.
statusstring [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
usersArray.<string> [Output Only] The URLs of the resources that are using this address.
-
compute(alpha).AddressAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] Unique identifier for the resource; defined by the server.
itemsobject [Output Only] A map of scoped address lists.
kindstring [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).AddressesScopedListobject
-
Properties:
Name Type Description addressesArray.<compute(alpha).Address> [Output Only] List of addresses contained in this scope.
warningobject [Output Only] Informational warning which replaces the list of addresses when the list is empty.
-
compute(alpha).AddressListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Address> [Output Only] A list of addresses.
kindstring [Output Only] Type of resource. Always compute#addressList for lists of addresses.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for the resource.
-
compute(alpha).AttachedDiskobject
-
Properties:
Name Type Description autoDeleteboolean Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
bootboolean Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
deviceNamestring Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
diskEncryptionKeycompute(alpha).CustomerEncryptionKey Encrypts or decrypts a disk using a customer-supplied encryption key.
If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
indexinteger Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
initializeParamscompute(alpha).AttachedDiskInitializeParams [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
This property is mutually exclusive with the source property; you can only define one or the other, but not both.
interfacestring Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
kindstring [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
licensesArray.<string> [Output Only] Any valid publicly visible licenses.
modestring The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
sourcestring Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk.
typestring Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
-
compute(alpha).AttachedDiskInitializeParamsobject
-
- https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
- projects/project/zones/zone/diskTypes/diskType
- zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
Properties:
Name Type Description diskNamestring Specifies the disk name. If not specified, the default is to use the name of the instance.
diskSizeGbstring Specifies the size of the disk in base-2 GB.
diskStorageTypestring [Deprecated] Storage type of the disk.
diskTypestring Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
sourceImagestring The source image used to create this disk. If the source image is deleted, this field will not be set.
To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
projects/debian-cloud/global/images/family/debian-8
Alternatively, use a specific version of a public operating system image:
projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
To create a disk with a private image that you created, specify the image name in the following format:
global/images/my-private-image
You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
global/images/family/my-private-family
sourceImageEncryptionKeycompute(alpha).CustomerEncryptionKey The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
-
compute(alpha).AuditConfigobject
-
Properties:
Name Type Description exemptedMembersArray.<string> Specifies the identities that are exempted from "data access" audit logging for the
servicespecified above. Follows the same format of Binding.members.servicestring Specifies a service that will be enabled for "data access" audit logging. For example,
resourcemanager,storage,compute.allServicesis a special value that covers all services. -
compute(alpha).Autoscalerobject
-
Properties:
Name Type Description autoscalingPolicycompute(alpha).AutoscalingPolicy The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.
If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.8 or 80%.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
regionstring [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
selfLinkstring [Output Only] Server-defined URL for the resource.
statusstring [Output Only] The status of the autoscaler configuration.
statusDetailsArray.<compute(alpha).AutoscalerStatusDetails> [Output Only] Human-readable details about the current state of the autoscaler. Examples: ?Error when fetching replicas: Replica Pool xxx doesn?t exist.? ?Autoscaling capped at min_num_replicas: 2.?
targetstring URL of the managed instance group that this autoscaler will scale.
zonestring [Output Only] URL of the zone where the instance group resides.
-
compute(alpha).AutoscalerAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsobject A map of scoped autoscaler lists.
kindstring [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).AutoscalerListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Autoscaler> A list of Autoscaler resources.
kindstring [Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).AutoscalersScopedListobject
-
Properties:
Name Type Description autoscalersArray.<compute(alpha).Autoscaler> [Output Only] List of autoscalers contained in this scope.
warningobject [Output Only] Informational warning which replaces the list of autoscalers when the list is empty.
-
compute(alpha).AutoscalerStatusDetailsobject
-
Properties:
Name Type Description messagestring typestring -
compute(alpha).AutoscalingPolicyobject
-
Properties:
Name Type Description coolDownPeriodSecinteger The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.
Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
cpuUtilizationcompute(alpha).AutoscalingPolicyCpuUtilization Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
customMetricUtilizationsArray.<compute(alpha).AutoscalingPolicyCustomMetricUtilization> Configuration parameters of autoscaling based on a custom metric.
loadBalancingUtilizationcompute(alpha).AutoscalingPolicyLoadBalancingUtilization Configuration parameters of autoscaling based on load balancer.
maxNumReplicasinteger The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
minNumReplicasinteger The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
queueBasedScalingcompute(alpha).AutoscalingPolicyQueueBasedScaling Configuration parameters of autoscaling based on queuing system.
-
compute(alpha).AutoscalingPolicyCpuUtilizationobject
-
Properties:
Name Type Description utilizationTargetnumber The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.8.
If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.
If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
-
compute(alpha).AutoscalingPolicyCustomMetricUtilizationobject
-
Properties:
Name Type Description metricstring The identifier of the Cloud Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.
For example, the following is a valid metric: compute.googleapis.com/instance/network/received_bytes_count
The following is not a valid metric because it does not increase or decrease based on usage: compute.googleapis.com/instance/cpu/reserved_cores
utilizationTargetnumber Target value of the metric which autoscaler should maintain. Must be a positive value.
utilizationTargetTypestring Defines how target utilization value is expressed for a Cloud Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.
-
compute(alpha).AutoscalingPolicyLoadBalancingUtilizationobject
-
Properties:
Name Type Description utilizationTargetnumber Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
-
compute(alpha).AutoscalingPolicyQueueBasedScalingobject
-
Properties:
Name Type Description acceptableBacklogPerInstancenumber Scaling based on the average number of tasks in the queue per each active instance. The autoscaler keeps the average number of tasks per instance below this number, based on data collected in the last couple of minutes. The autoscaler will also take into account incoming tasks when calculating when to scale.
cloudPubSubcompute(alpha).AutoscalingPolicyQueueBasedScalingCloudPubSub Configuration for Cloud Pub/Sub subscription queue.
singleWorkerThroughputPerSecnumber The scaling algorithm will also calculate throughput estimates on its own; if you explicitly provide this value, the autoscaler will take into account your value as well as automatic estimates when deciding how to scale.
-
compute(alpha).AutoscalingPolicyQueueBasedScalingCloudPubSubobject
-
Properties:
Name Type Description subscriptionstring Cloud Pub/Sub subscription used for scaling. Provide the partial URL (starting with projects/) or just the subscription name. The subscription must be assigned to the topic specified in topicName and must be in a pull configuration. The subscription must belong to the same project as the Autoscaler.
topicstring Cloud Pub/Sub topic used for scaling. Provide the partial URL or partial URL (starting with projects/) or just the topic name. The topic must belong to the same project as the Autoscaler resource.
-
compute(alpha).Backendobject
-
Properties:
Name Type Description balancingModestring Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
This cannot be used for internal load balancing.
capacityScalernumber A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
This cannot be used for internal load balancing.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
groupstring The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.
maxConnectionsinteger The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
This cannot be used for internal load balancing.
maxConnectionsPerInstanceinteger The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.
This cannot be used for internal load balancing.
maxRateinteger The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
This cannot be used for internal load balancing.
maxRatePerInstancenumber The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
This cannot be used for internal load balancing.
maxUtilizationnumber Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
This cannot be used for internal load balancing.
-
compute(alpha).BackendBucketobject
-
Properties:
Name Type Description bucketNamestring Cloud Storage bucket name.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional textual description of the resource; provided by the client when the resource is created.
enableCdnboolean If true, enable Cloud CDN for this BackendBucket.
idstring [Output Only] Unique identifier for the resource; defined by the server.
kindstring Type of the resource.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
selfLinkstring [Output Only] Server-defined URL for the resource.
-
compute(alpha).BackendBucketListobject
-
Properties:
Name Type Description idstring [Output Only] Unique identifier for the resource; defined by the server.
itemsArray.<compute(alpha).BackendBucket> A list of BackendBucket resources.
kindstring Type of resource.
nextPageTokenstring [Output Only] A token used to continue a truncated list request.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).BackendServiceobject
-
Properties:
Name Type Description affinityCookieTtlSecinteger Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day.
When the load balancing scheme is INTERNAL, this field is not used.
backendSslPolicycompute(alpha).BackendSSLPolicy Backend SSL policies to enforce.
backendsArray.<compute(alpha).Backend> The list of backends that serve this BackendService.
connectionDrainingcompute(alpha).ConnectionDraining creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
enableCDNboolean If true, enable Cloud CDN for this BackendService.
When the load balancing scheme is INTERNAL, this field is not used.
fingerprintstring Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
healthChecksArray.<string> The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
For internal load balancing, a URL to a HealthCheck resource must be specified instead.
iaapcompute(alpha).BackendServiceIAAP idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of resource. Always compute#backendService for backend services.
loadBalancingSchemestring namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
portinteger Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
This cannot be used for internal load balancing.
portNamestring Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.
When the load balancing scheme is INTERNAL, this field is not used.
protocolstring The protocol this BackendService uses to communicate with backends.
Possible values are HTTP, HTTPS, HTTP2, TCP and SSL. The default is HTTP.
For internal load balancing, the possible values are TCP and UDP, and the default is TCP.
regionstring [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services.
selfLinkstring [Output Only] Server-defined URL for the resource.
sessionAffinitystring Type of session affinity to use. The default is NONE.
When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
When the protocol is UDP, this field is not used.
timeoutSecinteger How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
-
compute(alpha).BackendServiceGroupHealthobject
-
Properties:
Name Type Description healthStatusArray.<compute(alpha).HealthStatus> kindstring [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.
-
compute(alpha).BackendServiceIAAPobject
-
Properties:
Name Type Description enabledboolean oauth2ClientIdstring oauth2ClientSecretstring oauth2ClientSecretSha256string -
compute(alpha).BackendServiceListobject
-
Properties:
Name Type Description idstring [Output Only] Unique identifier for the resource; defined by the server.
itemsArray.<compute(alpha).BackendService> A list of BackendService resources.
kindstring [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
nextPageTokenstring [Output Only] A token used to continue a truncated list request.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).BackendSSLPolicyobject
-
Properties:
Name Type Description pinnedPeerCertificatesArray.<string> List of PEM-encoded peer certificates, from which the public keys are extracted for authenticating the backend service.
-
compute(alpha).Bindingobject
-
Properties:
Name Type Description membersArray.<string> Specifies the identities requesting access for a Cloud Platform resource.
memberscan have the following values:allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.user:{emailid}: An email address that represents a specific Google account. For example,alice@gmail.comorjoe@example.com.serviceAccount:{emailid}: An email address that represents a service account. For example,my-other-app@appspot.gserviceaccount.com.group:{emailid}: An email address that represents a Google group. For example,admins@example.com.domain:{domain}: A Google Apps domain name that represents all the users of that domain. For example,google.comorexample.com.rolestring Role that is assigned to
members. For example,roles/viewer,roles/editor, orroles/owner. -
compute(alpha).CacheInvalidationRuleobject
-
Properties:
Name Type Description hoststring If host is non-empty, this invalidation rule will only apply to requests with a Host header matching host.
pathstring -
compute(alpha).Conditionobject
-
Properties:
Name Type Description iamstring Trusted attributes supplied by the IAM system.
opstring An operator to apply the subject with.
svcstring Trusted attributes discharged by the service.
sysstring Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
valuestring DEPRECATED. Use 'values' instead.
valuesArray.<string> The objects of the condition. This is mutually exclusive with 'value'.
-
compute(alpha).ConnectionDrainingobject
-
Properties:
Name Type Description drainingTimeoutSecinteger Time for which instance will be drained (not accept new connections, but still work to finish started).
-
compute(alpha).CustomerEncryptionKeyobject
-
- The key is wrapped using a RSA public key certificate provided by Google.
- After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Get the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Properties:
Name Type Description rawKeystring Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
rsaEncryptedKeystring Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
The key must meet the following requirements before you can provide it to Compute Engine:
sha256string [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
-
compute(alpha).CustomerEncryptionKeyProtectedDiskobject
-
Properties:
Name Type Description diskEncryptionKeycompute(alpha).CustomerEncryptionKey Decrypts data associated with the disk with a customer-supplied encryption key.
sourcestring Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
-
compute(alpha).DeprecationStatusobject
-
Properties:
Name Type Description deletedstring An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
deprecatedstring An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
obsoletestring An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
replacementstring The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
statestring The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
-
compute(alpha).Diskobject
-
- https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
- projects/project/global/snapshots/snapshot
- global/snapshots/snapshot
Properties:
Name Type Description creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
diskEncryptionKeycompute(alpha).CustomerEncryptionKey Encrypts the disk using a customer-supplied encryption key.
After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine).
Customer-supplied encryption keys do not protect access to metadata of the disk.
If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of the resource. Always compute#disk for disks.
labelFingerprintstring A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
To see the latest fingerprint, make a get() request to retrieve a disk.
labelsobject Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
lastAttachTimestampstring [Output Only] Last attach timestamp in RFC3339 text format.
lastDetachTimestampstring [Output Only] Last detach timestamp in RFC3339 text format.
licensesArray.<string> Any applicable publicly visible licenses.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optionsstring Internal use only.
regionstring [Output Only] URL of the region where the disk resides. Only applicable for regional resources.
replicaZonesArray.<string> URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
selfLinkstring [Output Only] Server-defined fully-qualified URL for this resource.
sizeGbstring Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
sourceImagestring The source image used to create this disk. If the source image is deleted, this field will not be set.
To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:
projects/debian-cloud/global/images/family/debian-8
Alternatively, use a specific version of a public operating system image:
projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD
To create a disk with a private image that you created, specify the image name in the following format:
global/images/my-private-image
You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
global/images/family/my-private-family
sourceImageEncryptionKeycompute(alpha).CustomerEncryptionKey The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
sourceImageIdstring [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
sourceSnapshotstring The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
sourceSnapshotEncryptionKeycompute(alpha).CustomerEncryptionKey The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
sourceSnapshotIdstring [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
statusstring [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
storageTypestring [Deprecated] Storage type of the persistent disk.
typestring URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
usersArray.<string> [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
zonestring [Output Only] URL of the zone where the disk resides.
-
compute(alpha).DiskAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsobject [Output Only] A map of scoped disk lists.
kindstring [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).DiskListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Disk> [Output Only] A list of persistent disks.
kindstring [Output Only] Type of resource. Always compute#diskList for lists of disks.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).DiskMoveRequestobject
-
- https://www.googleapis.com/compute/v1/projects/project/zones/zone
- projects/project/zones/zone
- zones/zone
- https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
- projects/project/zones/zone/disks/disk
- zones/zone/disks/disk
Properties:
Name Type Description destinationZonestring The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
targetDiskstring The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk:
-
compute(alpha).DisksResizeRequestobject
-
Properties:
Name Type Description sizeGbstring The new size of the persistent disk, which is specified in GB.
-
compute(alpha).DisksScopedListobject
-
Properties:
Name Type Description disksArray.<compute(alpha).Disk> [Output Only] List of disks contained in this scope.
warningobject [Output Only] Informational warning which replaces the list of disks when the list is empty.
-
compute(alpha).DiskTypeobject
-
Properties:
Name Type Description creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
defaultDiskSizeGbstring [Output Only] Server-defined default disk size in GB.
deprecatedcompute(alpha).DeprecationStatus [Output Only] The deprecation status associated with this disk type.
descriptionstring [Output Only] An optional description of this resource.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of the resource. Always compute#diskType for disk types.
namestring [Output Only] Name of the resource.
selfLinkstring [Output Only] Server-defined URL for the resource.
validDiskSizestring [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
zonestring [Output Only] URL of the zone where the disk type resides.
-
compute(alpha).DiskTypeAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsobject [Output Only] A map of scoped disk type lists.
kindstring [Output Only] Type of resource. Always compute#diskTypeAggregatedList.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).DiskTypeListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).DiskType> [Output Only] A list of Disk Type resources.
kindstring [Output Only] Type of resource. Always compute#diskTypeList for disk types.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).DiskTypesScopedListobject
-
Properties:
Name Type Description diskTypesArray.<compute(alpha).DiskType> [Output Only] List of disk types contained in this scope.
warningobject [Output Only] Informational warning which replaces the list of disk types when the list is empty.
-
compute(alpha).Firewallobject
-
- https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network
- projects/myproject/global/networks/my-network
- global/networks/default
Properties:
Name Type Description allowedArray.<object> The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
namestring Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
networkstring URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
selfLinkstring [Output Only] Server-defined URL for the resource.
sourceRangesArray.<string> If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
sourceTagsArray.<string> If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
targetTagsArray.<string> A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
-
compute(alpha).FirewallListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Firewall> [Output Only] A list of Firewall resources.
kindstring [Output Only] Type of resource. Always compute#firewallList for lists of firewalls.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).FixedOrPercentobject
-
Properties:
Name Type Description calculatedinteger [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
fixedinteger fixed must be non-negative.
percentinteger percent must belong to [0, 100].
-
compute(alpha).ForwardingRuleobject
-
Properties:
Name Type Description IPAddressstring The IP address that this forwarding rule is serving on behalf of.
For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. By default, this field is empty and an ephemeral IP from the same scope (global or regional) will be assigned.
When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnetwork configured for the forwarding rule. A reserved address cannot be used. If the field is empty, the IP address will be automatically allocated from the internal IP range of the subnetwork or network configured for this forwarding rule.
IPProtocolstring The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.
When the load balancing scheme is INTERNAL</code, only TCP and UDP are valid.
backendServicestring This field is not used for external load balancing.
For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
loadBalancingSchemestring This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
namestring Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
networkstring This field is not used for external load balancing.
For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
portRangestring Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
This field is not used for internal load balancing.
portsArray.<string> This field is not used for external load balancing.
When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. If the port list is not provided then all ports are allowed to pass through.
You may specify a maximum of up to 5 ports.
regionstring [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
selfLinkstring [Output Only] Server-defined URL for the resource.
subnetworkstring This field is not used for external load balancing.
For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.
If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
targetstring The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
This field is not used for internal load balancing.
-
compute(alpha).ForwardingRuleAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsobject A map of scoped forwarding rule lists.
kindstring [Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).ForwardingRuleListobject
-
Properties:
Name Type Description idstring [Output Only] Unique identifier for the resource. Set by the server.
itemsArray.<compute(alpha).ForwardingRule> A list of ForwardingRule resources.
kindstring Type of resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).ForwardingRulesScopedListobject
-
Properties:
Name Type Description forwardingRulesArray.<compute(alpha).ForwardingRule> List of forwarding rules contained in this scope.
warningobject Informational warning which replaces the list of forwarding rules when the list is empty.
-
compute(alpha).GlobalSetLabelsRequestobject
-
Properties:
Name Type Description labelFingerprintstring The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.
labelsobject A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
-
compute(alpha).GuestOsFeatureobject
-
Properties:
Name Type Description typestring The type of supported feature..
-
compute(alpha).HealthCheckobject
-
Properties:
Name Type Description checkIntervalSecinteger How often (in seconds) to send a health check. The default value is 5 seconds.
creationTimestampstring [Output Only] Creation timestamp in 3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
healthyThresholdinteger A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
http2HealthCheckcompute(alpha).HTTP2HealthCheck httpHealthCheckcompute(alpha).HTTPHealthCheck httpsHealthCheckcompute(alpha).HTTPSHealthCheck idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring Type of the resource.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
selfLinkstring [Output Only] Server-defined URL for the resource.
sslHealthCheckcompute(alpha).SSLHealthCheck tcpHealthCheckcompute(alpha).TCPHealthCheck timeoutSecinteger How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
typestring Specifies the type of the healthCheck, either TCP, UDP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
unhealthyThresholdinteger A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
-
compute(alpha).HealthCheckListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).HealthCheck> A list of HealthCheck resources.
kindstring Type of resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).HealthCheckReferenceobject
-
Properties:
Name Type Description healthCheckstring -
compute(alpha).HealthStatusobject
-
Properties:
Name Type Description healthStatestring Health state of the instance.
instancestring URL of the instance resource.
ipAddressstring The IP address represented by this resource.
portinteger The port on the instance.
-
compute(alpha).HostRuleobject
-
Properties:
Name Type Description descriptionstring An optional description of this resource. Provide this property when you create the resource.
hostsArray.<string> The list of host patterns to match. They must be valid hostnames, except will match any string of ([a-z0-9-.]). In that case, * must be the first character and must be followed in the pattern by either - or ..
pathMatcherstring The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.
-
compute(alpha).HTTP2HealthCheckobject
-
Properties:
Name Type Description hoststring The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
portinteger The TCP port number for the health check request. The default value is 443.
portNamestring Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
proxyHeaderstring Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
requestPathstring The request path of the HTTP/2 health check request. The default value is /.
-
compute(alpha).HttpHealthCheckobject
-
Properties:
Name Type Description checkIntervalSecinteger How often (in seconds) to send a health check. The default value is 5 seconds.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
healthyThresholdinteger A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
hoststring The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
portinteger The TCP port number for the HTTP health check request. The default value is 80.
requestPathstring The request path of the HTTP health check request. The default value is /.
selfLinkstring [Output Only] Server-defined URL for the resource.
timeoutSecinteger How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
unhealthyThresholdinteger A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
-
compute(alpha).HTTPHealthCheckobject
-
Properties:
Name Type Description hoststring The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
portinteger The TCP port number for the health check request. The default value is 80.
portNamestring Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
proxyHeaderstring Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
requestPathstring The request path of the HTTP health check request. The default value is /.
-
compute(alpha).HttpHealthCheckListobject
-
Properties:
Name Type Description idstring [Output Only] Unique identifier for the resource. Defined by the server.
itemsArray.<compute(alpha).HttpHealthCheck> A list of HttpHealthCheck resources.
kindstring Type of resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).HTTPSHealthCheckobject
-
Properties:
Name Type Description hoststring The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.
portinteger The TCP port number for the health check request. The default value is 443.
portNamestring Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
proxyHeaderstring Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
requestPathstring The request path of the HTTPS health check request. The default value is /.
-
compute(alpha).HttpsHealthCheckobject
-
Properties:
Name Type Description checkIntervalSecinteger How often (in seconds) to send a health check. The default value is 5 seconds.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
healthyThresholdinteger A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
hoststring The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring Type of the resource.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
portinteger The TCP port number for the HTTPS health check request. The default value is 443.
requestPathstring The request path of the HTTPS health check request. The default value is "/".
selfLinkstring [Output Only] Server-defined URL for the resource.
timeoutSecinteger How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
unhealthyThresholdinteger A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
-
compute(alpha).HttpsHealthCheckListobject
-
Properties:
Name Type Description idstring [Output Only] Unique identifier for the resource; defined by the server.
itemsArray.<compute(alpha).HttpsHealthCheck> A list of HttpsHealthCheck resources.
kindstring Type of resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).Imageobject
-
- https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk
- projects/project/zones/zone/disk/disk
- zones/zone/disks/disk
Properties:
Name Type Description archiveSizeBytesstring Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
deprecatedcompute(alpha).DeprecationStatus The deprecation status associated with this image.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
diskSizeGbstring Size of the image when restored onto a persistent disk (in GB).
familystring The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.
guestOsFeaturesArray.<compute(alpha).GuestOsFeature> Features of the guest os, valid for bootable images only.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
imageEncryptionKeycompute(alpha).CustomerEncryptionKey Encrypts the image using a customer-supplied encryption key.
After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).
Customer-supplied encryption keys do not protect access to metadata of the disk.
If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.
kindstring [Output Only] Type of the resource. Always compute#image for images.
labelFingerprintstring A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
To see the latest fingerprint, make a get() request to retrieve an image.
labelsobject Labels to apply to this image. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
licensesArray.<string> Any applicable license URI.
namestring Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
rawDiskobject The parameters of the raw disk image.
selfLinkstring [Output Only] Server-defined URL for the resource.
sourceDiskstring URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:
sourceDiskEncryptionKeycompute(alpha).CustomerEncryptionKey The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
sourceDiskIdstring The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.
sourceTypestring The type of the image used to create this disk. The default and only value is RAW
statusstring [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
-
compute(alpha).ImageListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Image> [Output Only] A list of Image resources.
kindstring Type of resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).Instanceobject
-
Properties:
Name Type Description canIpForwardboolean Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
cpuPlatformstring [Output Only] The CPU platform used by this instance.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
disksArray.<compute(alpha).AttachedDisk> Array of disks associated with this instance. Persistent disks must be created before you can assign them.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
instanceEncryptionKeycompute(alpha).CustomerEncryptionKey Encrypts or decrypts data for an instance with a customer-supplied encryption key.
If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.
If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.
Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.
kindstring [Output Only] Type of the resource. Always compute#instance for instances.
labelFingerprintstring A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
To see the latest fingerprint, make get() request to the instance.
labelsobject Labels to apply to this instance. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
machineTypestring Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:
zones/us-central1-f/machineTypes/n1-standard-1
To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):
zones/zone/machineTypes/custom-CPUS-MEMORY
For example: zones/us-central1-f/machineTypes/custom-4-5120
For a full list of restrictions, read the Specifications for custom machine types.
metadatacompute(alpha).Metadata The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
namestring The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
networkInterfacesArray.<compute(alpha).NetworkInterface> An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance.
schedulingcompute(alpha).Scheduling Scheduling options for this instance.
selfLinkstring [Output Only] Server-defined URL for this resource.
serviceAccountsArray.<compute(alpha).ServiceAccount> A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
statusstring [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDED, SUSPENDING, and TERMINATED.
statusMessagestring [Output Only] An optional, human-readable explanation of the status.
tagscompute(alpha).Tags A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
zonestring [Output Only] URL of the zone where the instance resides.
-
compute(alpha).InstanceAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsobject [Output Only] A map of scoped instance lists.
kindstring [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).InstanceGroupobject
-
Properties:
Name Type Description creationTimestampstring [Output Only] The creation timestamp for this instance group in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
fingerprintstring [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
idstring [Output Only] A unique identifier for this resource type. The server generates this identifier.
kindstring [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
namestring The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
namedPortsArray.<compute(alpha).NamedPort> Assigns a name to a port number. For example: {name: "http", port: 80}
This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
Named ports apply to all instances in this instance group.
networkstring The URL of the network to which all instances in the instance group belong.
regionstring The URL of the region where the instance group is located.
selfLinkstring [Output Only] The URL for this instance group. The server generates this URL.
sizeinteger [Output Only] The total number of instances in the instance group.
subnetworkstring The URL of the subnetwork to which all instances in the instance group belong.
zonestring [Output Only] The URL of the zone where the instance group is located.
-
compute(alpha).InstanceGroupAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] A unique identifier for this aggregated list of instance groups. The server generates this identifier.
itemsobject A map of scoped instance group lists.
kindstring [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] The URL for this resource type. The server generates this URL.
-
compute(alpha).InstanceGroupListobject
-
Properties:
Name Type Description idstring [Output Only] A unique identifier for this list of instance groups. The server generates this identifier.
itemsArray.<compute(alpha).InstanceGroup> A list of instance groups.
kindstring [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] The URL for this resource type. The server generates this URL.
-
compute(alpha).InstanceGroupManagerobject
-
Properties:
Name Type Description autoHealingPoliciesArray.<compute(alpha).InstanceGroupManagerAutoHealingPolicy> The autohealing policy for this managed instance group. You can specify only one value.
baseInstanceNamestring The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
creationTimestampstring [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
currentActionscompute(alpha).InstanceGroupManagerActionsSummary [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
failoverActionstring The action to perform in case of zone failure (set only for Regional instance group managers).
fingerprintstring [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
idstring [Output Only] A unique identifier for this resource type. The server generates this identifier.
instanceGroupstring [Output Only] The URL of the Instance Group resource.
instanceTemplatestring The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
kindstring [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
namestring The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
namedPortsArray.<compute(alpha).NamedPort> Named ports configured for the Instance Groups complementary to this Instance Group Manager.
pendingActionscompute(alpha).InstanceGroupManagerPendingActionsSummary [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
regionstring [Output Only] URL of the region where the managed instance group resides.
selfLinkstring [Output Only] The URL for this managed instance group. The server defines this URL.
targetPoolsArray.<string> The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
targetSizeinteger The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
updatePolicycompute(alpha).InstanceGroupManagerUpdatePolicy The update policy for this managed instance group.
versionsArray.<compute(alpha).InstanceGroupManagerVersion> Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
zonestring The name of the zone where the managed instance group is located.
-
compute(alpha).InstanceGroupManagerActionsSummaryobject
-
Properties:
Name Type Description abandoninginteger [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
creatinginteger [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
creatingWithoutRetriesinteger [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's target_size value accordingly.
deletinginteger [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
noneinteger [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
recreatinginteger [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
refreshinginteger [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
restartinginteger [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
-
compute(alpha).InstanceGroupManagerAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] A unique identifier for this aggregated list of managed instance groups. The server generates this identifier.
itemsobject [Output Only] A map of filtered managed instance group lists.
kindstring [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] The URL for this resource type. The server generates this URL.
-
compute(alpha).InstanceGroupManagerAutoHealingPolicyobject
-
Properties:
Name Type Description healthCheckstring The URL for the HealthCheck that signals autohealing.
initialDelaySecinteger The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
-
compute(alpha).InstanceGroupManagerListobject
-
Properties:
Name Type Description idstring [Output Only] A unique identifier for this resource type. The server generates this identifier.
itemsArray.<compute(alpha).InstanceGroupManager> [Output Only] A list of managed instance groups.
kindstring [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] The URL for this resource type. The server generates this URL.
-
compute(alpha).InstanceGroupManagerPendingActionsSummaryobject
-
Properties:
Name Type Description creatinginteger [Output Only] The number of instances in the managed instance group that are pending to be created.
deletinginteger [Output Only] The number of instances in the managed instance group that are pending to be deleted.
recreatinginteger [Output Only] The number of instances in the managed instance group that are pending to be recreated.
restartinginteger [Output Only] The number of instances in the managed instance group that are pending to be restarted.
-
compute(alpha).InstanceGroupManagersAbandonInstancesRequestobject
-
Properties:
Name Type Description instancesArray.<string> The URL for one or more instances to abandon from the managed instance group.
-
compute(alpha).InstanceGroupManagersDeleteInstancesRequestobject
-
Properties:
Name Type Description instancesArray.<string> The list of instances to delete from this managed instance group. Specify one or more instance URLs.
-
compute(alpha).InstanceGroupManagersListManagedInstancesResponseobject
-
Properties:
Name Type Description managedInstancesArray.<compute(alpha).ManagedInstance> [Output Only] The list of instances in the managed instance group.
-
compute(alpha).InstanceGroupManagersRecreateInstancesRequestobject
-
Properties:
Name Type Description instancesArray.<string> The URL for one or more instances to recreate.
-
compute(alpha).InstanceGroupManagersResizeAdvancedRequestobject
-
Properties:
Name Type Description noCreationRetriesboolean If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attemps to recreate each instance continuously until it succeeds.
This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario.
This flag is applicable only to the current resize request. It does not influence other resize requests in any way.
You can see which instances is being creating in which mode by calling the get or listManagedInstances API.
targetSizeinteger The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.
-
compute(alpha).InstanceGroupManagersScopedListobject
-
Properties:
Name Type Description instanceGroupManagersArray.<compute(alpha).InstanceGroupManager> [Output Only] The list of managed instance groups that are contained in the specified project and zone.
warningobject [Output Only] The warning that replaces the list of managed instance groups when the list is empty.
-
compute(alpha).InstanceGroupManagersSetAutoHealingRequestobject
-
Properties:
Name Type Description autoHealingPoliciesArray.<compute(alpha).InstanceGroupManagerAutoHealingPolicy> -
compute(alpha).InstanceGroupManagersSetInstanceTemplateRequestobject
-
Properties:
Name Type Description instanceTemplatestring The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
-
compute(alpha).InstanceGroupManagersSetTargetPoolsRequestobject
-
Properties:
Name Type Description fingerprintstring The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
targetPoolsArray.<string> The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.
-
compute(alpha).InstanceGroupManagerUpdatePolicyobject
-
Properties:
Name Type Description maxSurgecompute(alpha).FixedOrPercent Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
maxUnavailablecompute(alpha).FixedOrPercent Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
minReadySecinteger Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
minimalActionstring Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
typestring -
compute(alpha).InstanceGroupManagerVersionobject
-
Properties:
Name Type Description instanceTemplatestring tagstring Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
targetSizecompute(alpha).FixedOrPercent Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
-
compute(alpha).InstanceGroupsAddInstancesRequestobject
-
Properties:
Name Type Description instancesArray.<compute(alpha).InstanceReference> The list of instances to add to the instance group.
-
compute(alpha).InstanceGroupsListInstancesobject
-
Properties:
Name Type Description idstring [Output Only] A unique identifier for this list of instances in the specified instance group. The server generates this identifier.
itemsArray.<compute(alpha).InstanceWithNamedPorts> [Output Only] A list of instances and any named ports that are assigned to those instances.
kindstring [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] The URL for this list of instances in the specified instance groups. The server generates this URL.
-
compute(alpha).InstanceGroupsListInstancesRequestobject
-
Properties:
Name Type Description instanceStatestring A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.
-
compute(alpha).InstanceGroupsRemoveInstancesRequestobject
-
Properties:
Name Type Description instancesArray.<compute(alpha).InstanceReference> The list of instances to remove from the instance group.
-
compute(alpha).InstanceGroupsScopedListobject
-
Properties:
Name Type Description instanceGroupsArray.<compute(alpha).InstanceGroup> [Output Only] The list of instance groups that are contained in this scope.
warningobject [Output Only] An informational warning that replaces the list of instance groups when the list is empty.
-
compute(alpha).InstanceGroupsSetNamedPortsRequestobject
-
Properties:
Name Type Description fingerprintstring The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
namedPortsArray.<compute(alpha).NamedPort> The list of named ports to set for this instance group.
-
compute(alpha).InstanceListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Instance> [Output Only] A list of instances.
kindstring [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).InstanceMoveRequestobject
-
- https://www.googleapis.com/compute/v1/projects/project/zones/zone
- projects/project/zones/zone
- zones/zone
- https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
- projects/project/zones/zone/instances/instance
- zones/zone/instances/instance
Properties:
Name Type Description destinationZonestring The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone:
targetInstancestring The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance:
-
compute(alpha).InstancePropertiesobject
-
Properties:
Name Type Description canIpForwardboolean Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
descriptionstring An optional text description for the instances that are created from this instance template.
disksArray.<compute(alpha).AttachedDisk> An array of disks that are associated with the instances that are created from this template.
labelsobject Labels to apply to instances that are created from this template. Each label key/value pair must comply with RFC1035. Label values may be empty.
machineTypestring The machine type to use for instances that are created from this template.
metadatacompute(alpha).Metadata The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.
networkInterfacesArray.<compute(alpha).NetworkInterface> An array of network access configurations for this interface.
schedulingcompute(alpha).Scheduling Specifies the scheduling options for the instances that are created from this template.
serviceAccountsArray.<compute(alpha).ServiceAccount> A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
tagscompute(alpha).Tags A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.
-
compute(alpha).InstanceReferenceobject
-
Properties:
Name Type Description instancestring The URL for a specific instance.
-
compute(alpha).InstancesScopedListobject
-
Properties:
Name Type Description instancesArray.<compute(alpha).Instance> [Output Only] List of instances contained in this scope.
warningobject [Output Only] Informational warning which replaces the list of instances when the list is empty.
-
compute(alpha).InstancesSetLabelsRequestobject
-
Properties:
Name Type Description labelFingerprintstring Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.
labelsobject A list of labels to apply for this instance. Changing instance labels will also change the instance tags.
Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
-
compute(alpha).InstancesSetMachineTypeRequestobject
-
Properties:
Name Type Description machineTypestring Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1
-
compute(alpha).InstancesSetServiceAccountRequestobject
-
Properties:
Name Type Description emailstring Email address of the service account.
scopesArray.<string> The list of scopes to be made available for this service account.
-
compute(alpha).InstancesStartWithEncryptionKeyRequestobject
-
Properties:
Name Type Description disksArray.<compute(alpha).CustomerEncryptionKeyProtectedDisk> Array of disks associated with this instance that are protected with a customer-supplied encryption key.
In order to start the instance, the disk url and its corresponding key must be provided.
If the disk is not protected with a customer-supplied encryption key it should not be specified.
instanceEncryptionKeycompute(alpha).CustomerEncryptionKey Decrypts data associated with an instance that is protected with a customer-supplied encryption key.
If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance start will not succeed.
-
compute(alpha).InstanceTemplateobject
-
- https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
- projects/project/zones/zone/instances/instance
Properties:
Name Type Description creationTimestampstring [Output Only] The creation timestamp for this instance template in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
idstring [Output Only] A unique identifier for this instance template. The server defines this identifier.
kindstring [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
namestring Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
propertiescompute(alpha).InstanceProperties The instance properties for this instance template.
selfLinkstring [Output Only] The URL for this instance template. The server defines this URL.
sourceInstancestring The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
-
compute(alpha).InstanceTemplateListobject
-
Properties:
Name Type Description idstring [Output Only] A unique identifier for this instance template. The server defines this identifier.
itemsArray.<compute(alpha).InstanceTemplate> [Output Only] list of InstanceTemplate resources.
kindstring [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] The URL for this instance template list. The server defines this URL.
-
compute(alpha).InstanceWithNamedPortsobject
-
Properties:
Name Type Description instancestring [Output Only] The URL of the instance.
namedPortsArray.<compute(alpha).NamedPort> [Output Only] The named ports that belong to this instance group.
statusstring [Output Only] The status of the instance.
-
compute(alpha).Licenseobject
-
Properties:
Name Type Description chargesUseFeeboolean [Output Only] If true, the customer will be charged license fee for running software that contains this license on an instance.
kindstring [Output Only] Type of resource. Always compute#license for licenses.
namestring [Output Only] Name of the resource. The name is 1-63 characters long and complies with RFC1035.
selfLinkstring [Output Only] Server-defined URL for the resource.
-
compute(alpha).LogConfigobject
-
Properties:
Name Type Description countercompute(alpha).LogConfigCounterOptions Counter options.
-
compute(alpha).LogConfigCounterOptionsobject
-
Properties:
Name Type Description fieldstring The field value to attribute.
metricstring The metric to update.
-
compute(alpha).MachineTypeobject
-
Properties:
Name Type Description creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
deprecatedcompute(alpha).DeprecationStatus [Output Only] The deprecation status associated with this machine type.
descriptionstring [Output Only] An optional textual description of the resource.
guestCpusinteger [Output Only] The number of virtual CPUs that are available to the instance.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
isSharedCpuboolean [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
kindstring [Output Only] The type of the resource. Always compute#machineType for machine types.
maximumPersistentDisksinteger [Output Only] Maximum persistent disks allowed.
maximumPersistentDisksSizeGbstring [Output Only] Maximum total persistent disks size (GB) allowed.
memoryMbinteger [Output Only] The amount of physical memory available to the instance, defined in MB.
namestring [Output Only] Name of the resource.
selfLinkstring [Output Only] Server-defined URL for the resource.
zonestring [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
-
compute(alpha).MachineTypeAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsobject [Output Only] A map of scoped machine type lists.
kindstring [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).MachineTypeListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).MachineType> [Output Only] A list of Machine Type resources.
kindstring [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).MachineTypesScopedListobject
-
Properties:
Name Type Description machineTypesArray.<compute(alpha).MachineType> [Output Only] List of machine types contained in this scope.
warningobject [Output Only] An informational warning that appears when the machine types list is empty.
-
compute(alpha).ManagedInstanceobject
-
- NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
- CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
- CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
- RECREATING The managed instance group is recreating this instance.
- DELETING The managed instance group is permanently deleting this instance.
- ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
- RESTARTING The managed instance group is restarting the instance.
- REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
Properties:
Name Type Description currentActionstring [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
idstring [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
instancestring [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
instanceStatusstring [Output Only] The status of the instance. This field is empty when the instance does not exist.
instanceTemplatestring [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.
lastAttemptcompute(alpha).ManagedInstanceLastAttempt [Output Only] Information about the last attempt to create or delete the instance.
standbyModestring [Output Only] Standby mode of the instance. This field is non-empty iff the instance is a standby.
tagstring [Output Only] Tag describing the version.
-
compute(alpha).ManagedInstanceLastAttemptobject
-
Properties:
Name Type Description errorsobject [Output Only] Encountered errors during the last attempt to create or delete the instance.
-
compute(alpha).Metadataobject
-
Properties:
Name Type Description fingerprintstring Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
itemsArray.<object> Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
kindstring [Output Only] Type of the resource. Always compute#metadata for metadata.
-
compute(alpha).NamedPortobject
-
Properties:
Name Type Description namestring The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
portinteger The port number, which can be a value between 1 and 65535.
-
compute(alpha).Networkobject
-
Properties:
Name Type Description IPv4Rangestring The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
autoCreateSubnetworksboolean When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
gatewayIPv4string A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of the resource. Always compute#network for networks.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
selfLinkstring [Output Only] Server-defined URL for the resource.
subnetworksArray.<string> [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
-
compute(alpha).NetworkInterfaceobject
-
- https://www.googleapis.com/compute/v1/projects/project/global/networks/network
- projects/project/global/networks/network
- global/networks/default
- https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
- regions/region/subnetworks/subnetwork
Properties:
Name Type Description accessConfigsArray.<compute(alpha).AccessConfig> An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
namestring [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
networkstring URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:
global/networks/default
If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
networkIPstring An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
subnetworkstring The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
-
compute(alpha).NetworkListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Network> [Output Only] A list of Network resources.
kindstring [Output Only] Type of resource. Always compute#networkList for lists of networks.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource .
-
compute(alpha).Operationobject
-
Properties:
Name Type Description clientOperationIdstring [Output Only] Reserved for future use.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring [Output Only] A textual description of the operation, which is set when the operation is created.
endTimestring [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
errorobject [Output Only] If errors are generated during processing of the operation, this field will be populated.
httpErrorMessagestring [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
httpErrorStatusCodeinteger [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
insertTimestring [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
kindstring [Output Only] Type of the resource. Always compute#operation for Operation resources.
namestring [Output Only] Name of the resource.
operationTypestring [Output Only] The type of operation, such as insert, update, or delete, and so on.
progressinteger [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
regionstring [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
selfLinkstring [Output Only] Server-defined URL for the resource.
startTimestring [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
statusstring [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
statusMessagestring [Output Only] An optional textual description of the current status of the operation.
targetIdstring [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
targetLinkstring [Output Only] The URL of the resource that the operation modifies.
userstring [Output Only] User who requested the operation, for example: user@example.com.
warningsArray.<object> [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
zonestring [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
-
compute(alpha).OperationAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsobject [Output Only] A map of scoped operation lists.
kindstring [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).OperationListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Operation> [Output Only] A list of Operation resources.
kindstring [Output Only] Type of resource. Always compute#operations for Operations resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).OperationsScopedListobject
-
Properties:
Name Type Description operationsArray.<compute(alpha).Operation> [Output Only] List of operations contained in this scope.
warningobject [Output Only] Informational warning which replaces the list of operations when the list is empty.
-
compute(alpha).PathMatcherobject
-
- https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
- compute/v1/projects/project/global/backendServices/backendService
- global/backendServices/backendService
Properties:
Name Type Description defaultServicestring The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource:
descriptionstring An optional description of this resource. Provide this property when you create the resource.
namestring The name to which this PathMatcher is referred by the HostRule.
pathRulesArray.<compute(alpha).PathRule> The list of path rules.
-
compute(alpha).PathRuleobject
-
Properties:
Name Type Description pathsArray.<string> The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.
servicestring The URL of the BackendService resource if this rule is matched.
-
compute(alpha).Policyobject
-
Properties:
Name Type Description auditConfigsArray.<compute(alpha).AuditConfig> Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
Note:
AuditConfigdoesn't apply to "admin activity", which always enables audit logging.bindingsArray.<compute(alpha).Binding> Associates a list of
membersto arole. Multiplebindingsmust not be specified for the samerole.bindingswith no members will result in an error.etagstring etagis used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of theetagin the read-modify-write cycle to perform policy updates in order to avoid race conditions: Anetagis returned in the response togetIamPolicy, and systems are expected to put that etag in the request tosetIamPolicyto ensure that their change will be applied to the same version of the policy.If no
etagis provided in the call tosetIamPolicy, then the existing policy is overwritten blindly.iamOwnedboolean rulesArray.<compute(alpha).Rule> If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
versioninteger Version of the
Policy. The default version is 0. -
compute(alpha).Projectobject
-
Properties:
Name Type Description commonInstanceMetadatacompute(alpha).Metadata Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
defaultServiceAccountstring [Output Only] Default service account used by VMs running in this project.
descriptionstring An optional textual description of the resource.
enabledFeaturesArray.<string> Restricted features enabled for use on this project.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
kindstring [Output Only] Type of the resource. Always compute#project for projects.
namestring The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
quotasArray.<compute(alpha).Quota> [Output Only] Quotas assigned to this project.
selfLinkstring [Output Only] Server-defined URL for the resource.
usageExportLocationcompute(alpha).UsageExportLocation The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
xpnProjectStatusstring [Output Only] The role this project has in a Cross Project Network (XPN) configuration. Currently only HOST projects are differentiated.
-
compute(alpha).ProjectsDisableXpnResourceRequestobject
-
Properties:
Name Type Description xpnResourcecompute(alpha).XpnResourceId XPN resource ID.
-
compute(alpha).ProjectsEnableXpnResourceRequestobject
-
Properties:
Name Type Description xpnResourcecompute(alpha).XpnResourceId XPN resource ID.
-
compute(alpha).ProjectsGetXpnResourcesobject
-
Properties:
Name Type Description kindstring [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of XPN resources.
resourcesArray.<compute(alpha).XpnResourceId> XPN resources attached to this project as their XPN host.
-
compute(alpha).ProjectsListXpnHostsRequestobject
-
Properties:
Name Type Description organizationstring Optional organization ID managed by Cloud Resource Manager, for which to list XPN host projects. If not specified, the organization will be inferred from the project.
-
compute(alpha).Quotaobject
-
Properties:
Name Type Description limitnumber [Output Only] Quota limit for this metric.
metricstring [Output Only] Name of the quota metric.
usagenumber [Output Only] Current usage of this metric.
-
compute(alpha).Regionobject
-
Properties:
Name Type Description creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
deprecatedcompute(alpha).DeprecationStatus [Output Only] The deprecation status associated with this region.
descriptionstring [Output Only] Textual description of the resource.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of the resource. Always compute#region for regions.
namestring [Output Only] Name of the resource.
quotasArray.<compute(alpha).Quota> [Output Only] Quotas assigned to this region.
selfLinkstring [Output Only] Server-defined URL for the resource.
statusstring [Output Only] Status of the region, either UP or DOWN.
zonesArray.<string> [Output Only] A list of zones available in this region, in the form of resource URLs.
-
compute(alpha).RegionAutoscalerListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Autoscaler> A list of autoscalers.
kindstring Type of resource.
nextPageTokenstring [Output Only] A token used to continue a truncated list request.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).RegionDiskListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Disk> [Output Only] A list of persistent disks.
kindstring [Output Only] Type of resource. Always compute#regionDiskList for lists of region disks.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).RegionDisksResizeRequestobject
-
Properties:
Name Type Description sizeGbstring The new size of the regional persistent disk, which is specified in GB.
-
compute(alpha).RegionDiskTypeListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).DiskType> [Output Only] A list of Disk Type resources.
kindstring [Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).RegionInstanceGroupListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).InstanceGroup> A list of InstanceGroup resources.
kindstring The resource type.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] The URL for this resource type. The server generates this URL.
-
compute(alpha).RegionInstanceGroupManagerListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).InstanceGroupManager> A list of managed instance groups.
kindstring [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.
nextPageTokenstring [Output only] A token used to continue a truncated list request.
selfLinkstring [Output only] The URL for this resource type. The server generates this URL.
-
compute(alpha).RegionInstanceGroupManagersAbandonInstancesRequestobject
-
Properties:
Name Type Description instancesArray.<string> The names of one or more instances to abandon.
-
compute(alpha).RegionInstanceGroupManagersDeleteInstancesRequestobject
-
Properties:
Name Type Description instancesArray.<string> The names of one or more instances to delete.
-
compute(alpha).RegionInstanceGroupManagersListInstancesResponseobject
-
Properties:
Name Type Description managedInstancesArray.<compute(alpha).ManagedInstance> List of managed instances.
-
compute(alpha).RegionInstanceGroupManagersRecreateRequestobject
-
Properties:
Name Type Description instancesArray.<string> The URL for one or more instances to recreate.
-
compute(alpha).RegionInstanceGroupManagersSetAutoHealingRequestobject
-
Properties:
Name Type Description autoHealingPoliciesArray.<compute(alpha).InstanceGroupManagerAutoHealingPolicy> -
compute(alpha).RegionInstanceGroupManagersSetTargetPoolsRequestobject
-
Properties:
Name Type Description fingerprintstring Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.
targetPoolsArray.<string> The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
-
compute(alpha).RegionInstanceGroupManagersSetTemplateRequestobject
-
Properties:
Name Type Description instanceTemplatestring URL of the InstanceTemplate resource from which all new instances will be created.
-
compute(alpha).RegionInstanceGroupsListInstancesobject
-
Properties:
Name Type Description idstring [Output Only] Unique identifier for the resource. Defined by the server.
itemsArray.<compute(alpha).InstanceWithNamedPorts> A list of instances and any named ports that are assigned to those instances.
kindstring The resource type.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for the resource.
-
compute(alpha).RegionInstanceGroupsListInstancesRequestobject
-
Properties:
Name Type Description instanceStatestring Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.
portNamestring Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.
-
compute(alpha).RegionInstanceGroupsSetNamedPortsRequestobject
-
Properties:
Name Type Description fingerprintstring The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
namedPortsArray.<compute(alpha).NamedPort> The list of named ports to set for this instance group.
-
compute(alpha).RegionListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Region> [Output Only] A list of Region resources.
kindstring [Output Only] Type of resource. Always compute#regionList for lists of regions.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).RegionSetLabelsRequestobject
-
Properties:
Name Type Description labelFingerprintstring The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.
labelsobject The labels to set for this resource.
-
compute(alpha).ResourceGroupReferenceobject
-
Properties:
Name Type Description groupstring A URI referencing one of the resource views listed in the backend service.
-
compute(alpha).Routeobject
-
Properties:
Name Type Description creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
destRangestring The destination range of outgoing packets that this route applies to.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of this resource. Always compute#routes for Route resources.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
networkstring Fully-qualified URL of the network that this route applies to.
nextHopGatewaystring The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
nextHopInstancestring The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
nextHopIpstring The network IP address of an instance that should handle matching packets.
nextHopNetworkstring The URL of the local network if it should handle matching packets.
nextHopVpnTunnelstring The URL to a VpnTunnel that should handle matching packets.
priorityinteger The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
selfLinkstring [Output Only] Server-defined fully-qualified URL for this resource.
tagsArray.<string> A list of instance tags to which this route applies.
warningsArray.<object> [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
-
compute(alpha).RouteListobject
-
Properties:
Name Type Description idstring [Output Only] Unique identifier for the resource. Defined by the server.
itemsArray.<compute(alpha).Route> [Output Only] A list of Route resources.
kindstring Type of resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).Routerobject
-
Properties:
Name Type Description bgpcompute(alpha).RouterBgp BGP information specific to this router.
bgpPeersArray.<compute(alpha).RouterBgpPeer> BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
interfacesArray.<compute(alpha).RouterInterface> Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel) or IP address and IP address range (e.g. ipRange).
kindstring [Output Only] Type of resource. Always compute#router for routers.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
networkstring URI of the network to which this router belongs.
regionstring [Output Only] URI of the region where the router resides.
selfLinkstring [Output Only] Server-defined URL for the resource.
-
compute(alpha).RouterAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsobject A map of scoped router lists.
kindstring Type of resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).RouterBgpobject
-
Properties:
Name Type Description asninteger Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
-
compute(alpha).RouterBgpPeerobject
-
Properties:
Name Type Description advertisedRoutePriorityinteger The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
interfaceNamestring Name of the interface the BGP peer is associated with.
ipAddressstring IP address of the interface inside Google Cloud Platform.
namestring Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
peerAsninteger Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
peerIpAddressstring IP address of the BGP interface outside Google cloud.
-
compute(alpha).RouterInterfaceobject
-
Properties:
Name Type Description ipRangestring IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
linkedVpnTunnelstring URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
namestring Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
-
compute(alpha).RouterListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Router> A list of Router resources.
kindstring [Output Only] Type of resource. Always compute#router for routers.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for the resource.
-
compute(alpha).RoutersPreviewResponseobject
-
Properties:
Name Type Description resourcecompute(alpha).Router Preview of given router.
-
compute(alpha).RoutersScopedListobject
-
Properties:
Name Type Description routersArray.<compute(alpha).Router> List of routers contained in this scope.
warningobject Informational warning which replaces the list of routers when the list is empty.
-
compute(alpha).RouterStatusobject
-
Properties:
Name Type Description bestRoutesArray.<compute(alpha).Route> Best routes for this router's network.
bgpPeerStatusArray.<compute(alpha).RouterStatusBgpPeerStatus> networkstring URI of the network to which this router belongs.
-
compute(alpha).RouterStatusBgpPeerStatusobject
-
Properties:
Name Type Description advertisedRoutesArray.<compute(alpha).Route> Routes that were advertised to the remote BGP peer
ipAddressstring IP address of the local BGP interface.
linkedVpnTunnelstring URL of the VPN tunnel that this BGP peer controls.
namestring Name of this BGP peer. Unique within the Routers resource.
numLearnedRoutesinteger Number of routes learned from the remote BGP Peer.
peerIpAddressstring IP address of the remote BGP interface.
statestring BGP state as specified in RFC1771.
statusstring Status of the BGP peer: {UP, DOWN}
uptimestring Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
uptimeSecondsstring Time this session has been up, in seconds. Format: 145
-
compute(alpha).RouterStatusResponseobject
-
Properties:
Name Type Description kindstring Type of resource.
resultcompute(alpha).RouterStatus -
compute(alpha).Ruleobject
-
Properties:
Name Type Description actionstring Required
conditionsArray.<compute(alpha).Condition> Additional restrictions that must be met
descriptionstring Human-readable description of the rule.
insArray.<string> If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
logConfigsArray.<compute(alpha).LogConfig> The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
notInsArray.<string> If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
permissionsArray.<string> A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '' matches all permissions, and a verb part of '' (e.g., 'storage.buckets.*') matches all verbs.
-
compute(alpha).Schedulingobject
-
Properties:
Name Type Description automaticRestartboolean Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
onHostMaintenancestring Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
preemptibleboolean Whether the instance is preemptible.
-
compute(alpha).SerialPortOutputobject
-
Properties:
Name Type Description contentsstring [Output Only] The contents of the console output.
kindstring [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.
nextstring [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter.
selfLinkstring [Output Only] Server-defined URL for the resource.
startstring [Output Only] The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched.
-
compute(alpha).ServiceAccountobject
-
Properties:
Name Type Description emailstring Email address of the service account.
scopesArray.<string> The list of scopes to be made available for this service account.
-
compute(alpha).Snapshotobject
-
Properties:
Name Type Description creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
diskSizeGbstring [Output Only] Size of the snapshot, specified in GB.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
labelFingerprintstring A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.
To see the latest fingerprint, make a get() request to retrieve a snapshot.
labelsobject Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
licensesArray.<string> [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
namestring Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
selfLinkstring [Output Only] Server-defined URL for the resource.
snapshotEncryptionKeycompute(alpha).CustomerEncryptionKey Encrypts the snapshot using a customer-supplied encryption key.
After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
Customer-supplied encryption keys do not protect access to metadata of the disk.
If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
sourceDiskstring [Output Only] The source disk used to create this snapshot.
sourceDiskEncryptionKeycompute(alpha).CustomerEncryptionKey The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
sourceDiskIdstring [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
statusstring [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
storageBytesstring [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
storageBytesStatusstring [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
-
compute(alpha).SnapshotListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Snapshot> [Output Only] A list of Snapshot resources.
kindstring Type of resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).SslCertificateobject
-
Properties:
Name Type Description certificatestring A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
privateKeystring A write-only private key in PEM format. Only insert RPCs will include this field.
selfLinkstring [Output only] Server-defined URL for the resource.
-
compute(alpha).SslCertificateListobject
-
Properties:
Name Type Description idstring [Output Only] Unique identifier for the resource. Defined by the server.
itemsArray.<compute(alpha).SslCertificate> A list of SslCertificate resources.
kindstring Type of resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).SSLHealthCheckobject
-
Properties:
Name Type Description portinteger The TCP port number for the health check request. The default value is 443.
portNamestring Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
proxyHeaderstring Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
requeststring The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
responsestring The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
-
compute(alpha).Subnetworkobject
-
Properties:
Name Type Description creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
gatewayAddressstring [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
ipCidrRangestring The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
kindstring [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
namestring The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
networkstring The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
privateIpGoogleAccessboolean Whether the VMs in this subnet can access Google services without assigned external IP addresses.
regionstring URL of the region where the Subnetwork resides.
selfLinkstring [Output Only] Server-defined URL for the resource.
-
compute(alpha).SubnetworkAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsobject [Output] A map of scoped Subnetwork lists.
kindstring [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).SubnetworkListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Subnetwork> The Subnetwork resources.
kindstring [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).SubnetworksExpandIpCidrRangeRequestobject
-
Properties:
Name Type Description ipCidrRangestring The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update.
-
compute(alpha).SubnetworksScopedListobject
-
Properties:
Name Type Description subnetworksArray.<compute(alpha).Subnetwork> List of subnetworks contained in this scope.
warningobject An informational warning that appears when the list of addresses is empty.
-
compute(alpha).Tagsobject
-
Properties:
Name Type Description fingerprintstring Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
To see the latest fingerprint, make get() request to the instance.
itemsArray.<string> An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
-
compute(alpha).TargetHttpProxyobject
-
Properties:
Name Type Description creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
selfLinkstring [Output Only] Server-defined URL for the resource.
urlMapstring URL to the UrlMap resource that defines the mapping from URL to the BackendService.
-
compute(alpha).TargetHttpProxyListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).TargetHttpProxy> A list of TargetHttpProxy resources.
kindstring Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).TargetHttpsProxiesSetSslCertificatesRequestobject
-
Properties:
Name Type Description sslCertificatesArray.<string> New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.
-
compute(alpha).TargetHttpsProxyobject
-
- https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
- projects/project/global/urlMaps/url-map
- global/urlMaps/url-map
Properties:
Name Type Description clientSslPolicystring URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
selfLinkstring [Output Only] Server-defined URL for the resource.
sslCertificatesArray.<string> URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
urlMapstring A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
-
compute(alpha).TargetHttpsProxyListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).TargetHttpsProxy> A list of TargetHttpsProxy resources.
kindstring Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).TargetInstanceobject
-
- https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
- projects/project/zones/zone/instances/instance
- zones/zone/instances/instance
Properties:
Name Type Description creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
instancestring A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
kindstring [Output Only] The type of the resource. Always compute#targetInstance for target instances.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
natPolicystring NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
selfLinkstring [Output Only] Server-defined URL for the resource.
zonestring [Output Only] URL of the zone where the target instance resides.
-
compute(alpha).TargetInstanceAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] Unique identifier for the resource; defined by the server.
itemsobject A map of scoped target instance lists.
kindstring Type of resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).TargetInstanceListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).TargetInstance> A list of TargetInstance resources.
kindstring Type of resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).TargetInstancesScopedListobject
-
Properties:
Name Type Description targetInstancesArray.<compute(alpha).TargetInstance> List of target instances contained in this scope.
warningobject Informational warning which replaces the list of addresses when the list is empty.
-
compute(alpha).TargetPoolobject
-
Properties:
Name Type Description backupPoolstring This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.
In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
failoverRationumber This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
healthChecksArray.<string> A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
instancesArray.<string> A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
kindstring [Output Only] Type of the resource. Always compute#targetPool for target pools.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
regionstring [Output Only] URL of the region where the target pool resides.
selfLinkstring [Output Only] Server-defined URL for the resource.
sessionAffinitystring Sesssion affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
-
compute(alpha).TargetPoolAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] Unique identifier for the resource. Defined by the server.
itemsobject [Output Only] A map of scoped target pool lists.
kindstring [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).TargetPoolInstanceHealthobject
-
Properties:
Name Type Description healthStatusArray.<compute(alpha).HealthStatus> kindstring [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.
-
compute(alpha).TargetPoolListobject
-
Properties:
Name Type Description idstring [Output Only] Unique identifier for the resource. Defined by the server.
itemsArray.<compute(alpha).TargetPool> A list of TargetPool resources.
kindstring [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).TargetPoolsAddHealthCheckRequestobject
-
Properties:
Name Type Description healthChecksArray.<compute(alpha).HealthCheckReference> A list of HttpHealthCheck resources to add to the target pool.
-
compute(alpha).TargetPoolsAddInstanceRequestobject
-
- https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
- projects/project-id/zones/zone/instances/instance-name
- zones/zone/instances/instance-name
Properties:
Name Type Description instancesArray.<compute(alpha).InstanceReference> A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs:
-
compute(alpha).TargetPoolsRemoveHealthCheckRequestobject
-
- https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
- projects/project/global/httpHealthChecks/health-check
- global/httpHealthChecks/health-check
Properties:
Name Type Description healthChecksArray.<compute(alpha).HealthCheckReference> Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:
-
compute(alpha).TargetPoolsRemoveInstanceRequestobject
-
Properties:
Name Type Description instancesArray.<compute(alpha).InstanceReference> URLs of the instances to be removed from target pool.
-
compute(alpha).TargetPoolsScopedListobject
-
Properties:
Name Type Description targetPoolsArray.<compute(alpha).TargetPool> List of target pools contained in this scope.
warningobject Informational warning which replaces the list of addresses when the list is empty.
-
compute(alpha).TargetReferenceobject
-
Properties:
Name Type Description targetstring -
compute(alpha).TargetSslProxiesSetBackendServiceRequestobject
-
Properties:
Name Type Description servicestring The URL of the new BackendService resource for the targetSslProxy.
-
compute(alpha).TargetSslProxiesSetProxyHeaderRequestobject
-
Properties:
Name Type Description proxyHeaderstring The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
-
compute(alpha).TargetSslProxiesSetSslCertificatesRequestobject
-
Properties:
Name Type Description sslCertificatesArray.<string> New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified.
-
compute(alpha).TargetSslProxyobject
-
Properties:
Name Type Description clientSslPolicystring URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers.
creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
proxyHeaderstring Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
selfLinkstring [Output Only] Server-defined URL for the resource.
servicestring URL to the BackendService resource.
sslCertificatesArray.<string> URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified.
-
compute(alpha).TargetSslProxyListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).TargetSslProxy> A list of TargetSslProxy resources.
kindstring Type of resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).TargetVpnGatewayobject
-
Properties:
Name Type Description creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
forwardingRulesArray.<string> [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
networkstring URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
regionstring [Output Only] URL of the region where the target VPN gateway resides.
selfLinkstring [Output Only] Server-defined URL for the resource.
statusstring [Output Only] The status of the VPN gateway.
tunnelsArray.<string> [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
-
compute(alpha).TargetVpnGatewayAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsobject A map of scoped target vpn gateway lists.
kindstring [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for the resource.
-
compute(alpha).TargetVpnGatewayListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).TargetVpnGateway> [Output Only] A list of TargetVpnGateway resources.
kindstring [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for the resource.
-
compute(alpha).TargetVpnGatewaysScopedListobject
-
Properties:
Name Type Description targetVpnGatewaysArray.<compute(alpha).TargetVpnGateway> [Output Only] List of target vpn gateways contained in this scope.
warningobject [Output Only] Informational warning which replaces the list of addresses when the list is empty.
-
compute(alpha).TCPHealthCheckobject
-
Properties:
Name Type Description portinteger The TCP port number for the health check request. The default value is 80.
portNamestring Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
proxyHeaderstring Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
requeststring The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
responsestring The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.
-
compute(alpha).TestFailureobject
-
Properties:
Name Type Description actualServicestring expectedServicestring hoststring pathstring -
compute(alpha).TestPermissionsRequestobject
-
Properties:
Name Type Description permissionsArray.<string> The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
-
compute(alpha).TestPermissionsResponseobject
-
Properties:
Name Type Description permissionsArray.<string> A subset of
TestPermissionsRequest.permissionsthat the caller is allowed. -
compute(alpha).UrlMapobject
-
Properties:
Name Type Description creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
defaultServicestring The URL of the BackendService resource if none of the hostRules match.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
fingerprintstring Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.
hostRulesArray.<compute(alpha).HostRule> The list of HostRules to use against the URL.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of the resource. Always compute#urlMaps for url maps.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
pathMatchersArray.<compute(alpha).PathMatcher> The list of named PathMatchers to use against the URL.
selfLinkstring [Output Only] Server-defined URL for the resource.
testsArray.<compute(alpha).UrlMapTest> The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.
-
compute(alpha).UrlMapListobject
-
Properties:
Name Type Description idstring [Output Only] Unique identifier for the resource. Set by the server.
itemsArray.<compute(alpha).UrlMap> A list of UrlMap resources.
kindstring Type of resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).UrlMapReferenceobject
-
Properties:
Name Type Description urlMapstring -
compute(alpha).UrlMapsValidateRequestobject
-
Properties:
Name Type Description resourcecompute(alpha).UrlMap Content of the UrlMap to be validated.
-
compute(alpha).UrlMapsValidateResponseobject
-
Properties:
Name Type Description resultcompute(alpha).UrlMapValidationResult -
compute(alpha).UrlMapTestobject
-
Properties:
Name Type Description descriptionstring Description of this test case.
hoststring Host portion of the URL.
pathstring Path portion of the URL.
servicestring Expected BackendService resource the given URL should be mapped to.
-
compute(alpha).UrlMapValidationResultobject
-
Properties:
Name Type Description loadErrorsArray.<string> loadSucceededboolean Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.
testFailuresArray.<compute(alpha).TestFailure> testPassedboolean If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.
-
compute(alpha).UsageExportLocationobject
-
Properties:
Name Type Description bucketNamestring The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
reportNamePrefixstring An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
-
compute(alpha).VpnTunnelobject
-
Properties:
Name Type Description creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
descriptionstring An optional description of this resource. Provide this property when you create the resource.
detailedStatusstring [Output Only] Detailed status message for the VPN tunnel.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
ikeVersioninteger IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
kindstring [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
localTrafficSelectorArray.<string> Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
namestring Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
peerIpstring IP address of the peer VPN gateway.
regionstring [Output Only] URL of the region where the VPN tunnel resides.
remoteTrafficSelectorArray.<string> Remote traffic selectors to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
routerstring URL of router resource to be used for dynamic routing.
selfLinkstring [Output Only] Server-defined URL for the resource.
sharedSecretstring Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
sharedSecretHashstring Hash of the shared secret.
statusstring [Output Only] The status of the VPN tunnel.
targetVpnGatewaystring URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
-
compute(alpha).VpnTunnelAggregatedListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsobject [Output Only] A map of scoped vpn tunnel lists.
kindstring [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).VpnTunnelListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).VpnTunnel> [Output Only] A list of VpnTunnel resources.
kindstring [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for the resource.
-
compute(alpha).VpnTunnelsScopedListobject
-
Properties:
Name Type Description vpnTunnelsArray.<compute(alpha).VpnTunnel> List of vpn tunnels contained in this scope.
warningobject Informational warning which replaces the list of addresses when the list is empty.
-
compute(alpha).XpnHostListobject
-
Properties:
Name Type Description idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
itemsArray.<compute(alpha).Project> [Output Only] A list of XPN host project URLs.
kindstring [Output Only] Type of resource. Always compute#xpnHostList for lists of XPN hosts.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource .
-
compute(alpha).XpnResourceIdobject
-
Properties:
Name Type Description idstring The ID of the XPN resource. In the case of projects, this field matches the project's name, not the canonical ID.
typestring The type of the XPN resource.
-
compute(alpha).Zoneobject
-
Properties:
Name Type Description creationTimestampstring [Output Only] Creation timestamp in RFC3339 text format.
deprecatedcompute(alpha).DeprecationStatus [Output Only] The deprecation status associated with this zone.
descriptionstring [Output Only] Textual description of the resource.
idstring [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindstring [Output Only] Type of the resource. Always compute#zone for zones.
namestring [Output Only] Name of the resource.
regionstring [Output Only] Full URL reference to the region which hosts the zone.
selfLinkstring [Output Only] Server-defined URL for the resource.
statusstring [Output Only] Status of the zone, either UP or DOWN.
-
compute(alpha).ZoneListobject
-
Properties:
Name Type Description idstring [Output Only] Unique identifier for the resource; defined by the server.
itemsArray.<compute(alpha).Zone> [Output Only] A list of Zone resources.
kindstring Type of resource.
nextPageTokenstring [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring [Output Only] Server-defined URL for this resource.
-
compute(alpha).ZoneSetLabelsRequestobject
-
Properties:
Name Type Description labelFingerprintstring The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.
labelsobject The labels to set for this resource.